com.tridion.util

Class JAXBUtil

java.lang.Object

com.tridion.util.JAXBUtil

public class JAXBUtil
extends Object

Contains methods for XML manipulation.

Method Summary

Modifier and Type	Method and Description
static void	deleteStateFile(File file) This will delete the state file.
static JAXBContext	getContext(Class<?> contextClass) This small utility method allows retrieval of the JAXBContext for a given class.
static void	marshalToFile(Object object, File file) Marshal an object to file.
static String	marshalToString(Object object) Marshal an object to a String.
static JAXBContext	registerContext(Class<?> contextClass) Allows registration of a specific context class to the jaxb context.
static JAXBContext	registerContext(Class<?> contextClass, JAXBContext context) Allows registration of a specific context with a specified jaxb context class.
static <T> T	unmarshalFromFile(Class<T> clazz, File file) Unmarshals XML from file.
static Object	unmarshalFromString(Class<?> clazz, String xml) Unmarshals an String based on the JAXB annotated class.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

deleteStateFile

public static void deleteStateFile(File file)

This will delete the state file.

Parameters:

file - the state file to delete.

getContext

public static JAXBContext getContext(Class<?> contextClass)
                              throws JAXBException

This small utility method allows retrieval of the JAXBContext for a given class. This will make sure the context is only loaded once during the life of the JVM for performance reasons.

Parameters:

contextClass - The context class to load the JAXBContext for

Returns:

The JAXBContext for the given class

Throws:

JAXBException - If unable to create the jaxbcontext

registerContext

public static JAXBContext registerContext(Class<?> contextClass,
                                          JAXBContext context)

Allows registration of a specific context with a specified jaxb context class.

Parameters:

contextClass - The context class for which the jaxb context applies to

context - The context to use for the context class

Returns:

The JAXBContext itself

registerContext

public static JAXBContext registerContext(Class<?> contextClass)
                                   throws JAXBException

Allows registration of a specific context class to the jaxb context.

Parameters:

contextClass - The context class for which the jaxb context applies to

Returns:

The JAXBContext itself

Throws:

JAXBException - If unable to register a context

marshalToString

public static String marshalToString(Object object)
                              throws JAXBException

Marshal an object to a String.

Parameters:

object - The JAXB annotated object.

Returns:

The String representation.

Throws:

JAXBException - on a marshal exception.

marshalToFile

public static void marshalToFile(Object object,
                                 File file)
                          throws JAXBException,
                                 IOException

Marshal an object to file.

Parameters:

object - The JAXB annotated object.

file - The file to marshal to.

Throws:

JAXBException - on a marshal exception.

IOException - on any I/O exception while writing to file.

unmarshalFromFile

public static <T> T unmarshalFromFile(Class<T> clazz,
                                      File file)
                               throws JAXBException

Unmarshals XML from file.

Parameters:

clazz - The JAXB annotated class.

file - The file to read from.

Returns:

The JAXB annotated object.

Throws:

JAXBException - on a marshal exception.

unmarshalFromString

public static Object unmarshalFromString(Class<?> clazz,
                                         String xml)

Unmarshals an String based on the JAXB annotated class.

Parameters:

clazz - The JAXB annotated class.

xml - The String representation.

Returns:

The JAXB annotated object.