core.tut.pori.utils

Class XMLFormatter

java.lang.Object

core.tut.pori.utils.XMLFormatter

public class XMLFormatter
extends java.lang.Object

XML formatter. This class can be used to marshal objects to xml output, and unmarshal objects from xml input.

Constructor Summary

Constructors

Constructor and Description
XMLFormatter()

Method Summary

Modifier and Type	Method and Description
boolean	isOmitXMLDeclaration()
boolean	isThrowOnError()
void	setOmitXMLDeclaration(boolean omitXML)
void	setThrowOnError(boolean throwOnError)
<T> T	toObject(java.io.InputStream in, java.lang.Class<T> cls)
<T> T	toObject(java.io.InputStream in, java.lang.Class<T> objectClass, java.lang.Class<?>... requiredClasses)
<T> T	toObject(org.w3c.dom.Node node, java.lang.Class<T> cls)
<T> T	toObject(java.lang.String string, java.lang.Class<T> cls)
Response	toResponse(java.io.InputStream in, java.lang.Class<?> dataClass)
java.lang.String	toString(org.w3c.dom.Document doc)
java.lang.String	toString(Response r)
<T> java.lang.String	toString(T o)

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLFormatter

public XMLFormatter()

Method Detail

toObject

public <T> T toObject(java.lang.String string,
                      java.lang.Class<T> cls)
               throws java.lang.IllegalArgumentException

Parameters:

string -

cls -

Returns:

the object or null if bad/null/empty string

Throws:

java.lang.IllegalArgumentException - on bad xml

toObject

public <T> T toObject(java.io.InputStream in,
                      java.lang.Class<T> cls)
               throws java.lang.IllegalArgumentException

Parameters:

in -

cls -

Returns:

the object or null if bad/null in

Throws:

java.lang.IllegalArgumentException - on bad xml

toObject

public <T> T toObject(java.io.InputStream in,
                      java.lang.Class<T> objectClass,
                      java.lang.Class<?>... requiredClasses)
               throws java.lang.IllegalArgumentException

Parameters:

in -

objectClass - class of the object to create

requiredClasses - additional classes required, note: objectClass is automatically added to requiredClasses

Returns:

the object or null if bad/null input

Throws:

java.lang.IllegalArgumentException - on bad xml

toObject

public <T> T toObject(org.w3c.dom.Node node,
                      java.lang.Class<T> cls)
               throws java.lang.IllegalArgumentException

Parameters:

node -

cls -

Returns:

the node as an object

Throws:

java.lang.IllegalArgumentException - on bad xml

toString

public java.lang.String toString(Response r)

Parameters:

r - annotated xml object

Returns:

the object as a xml string or null if bad object

toString

public <T> java.lang.String toString(T o)

Parameters:

o - annotated xml object

Returns:

the object as a xml string or null if bad object

toString

public java.lang.String toString(org.w3c.dom.Document doc)

Parameters:

doc -

Returns:

the document as string or null if not a valid document

isOmitXMLDeclaration

public boolean isOmitXMLDeclaration()

Returns:

true if xml declaration is omitted from the output

setOmitXMLDeclaration

public void setOmitXMLDeclaration(boolean omitXML)

Parameters:

omitXML -

isThrowOnError

public boolean isThrowOnError()

Returns:

the throwOnError

setThrowOnError

public void setThrowOnError(boolean throwOnError)

Parameters:

throwOnError - the throwOnError to set

toResponse

public Response toResponse(java.io.InputStream in,
                           java.lang.Class<?> dataClass)
                    throws java.lang.IllegalArgumentException

Parameters:

in -

dataClass -

Returns:

the object or null if bad/null input

Throws:

java.lang.IllegalArgumentException - on bad xml