org.josef.util.xml

Class MarshalParameters

java.lang.Object

org.josef.util.xml.MarshalParameters

public final class MarshalParameters
extends Object

Parameter class to marshal an object into XML (using JAXB).
This class can be used like this:

 final ExampleXmlElement object = new ExampleXmlElement("Test");
 final String xml = XmlUtil.marshal(new MarshalParameters.Builder(object).build(););

The builder also allows you to set properties. More features can easily be added later.

Version:

1.0 $Revision: 5785 $

Author:

Kees Schotanus

See Also:

XmlUtil.marshal(MarshalParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarshalParameters.Builder Builder class that builds MarshalParameters objects.

Method Summary

Modifier and Type	Method and Description
boolean	escape() Determines whether the XML is escaped (true) or not (false).
JAXBContext	getJaxbContext() Gets the optional JAXB context.
Object	getObject() Gets the object to marshal.
Map<String,Object>	getPoperties() Gets the marshalling properties.

Methods inherited from class java.lang.Object

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

Method Detail

getObject

public Object getObject()

Gets the object to marshal.

Returns:

The object to marshal.

getJaxbContext

public JAXBContext getJaxbContext()

Gets the optional JAXB context.

Returns:

The optional JAXB context.

escape

public boolean escape()

Determines whether the XML is escaped (true) or not (false).

Returns:

True when the XML is escaped, otherwise false.

getPoperties

public Map<String,Object> getPoperties()

Gets the marshalling properties.

Returns:

The marshalling properties.
The returned map may be empty but will never be null.