org.josef.util.xml

Class UnmarshalParameters

java.lang.Object

org.josef.util.xml.UnmarshalParameters

public class UnmarshalParameters
extends Object

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

 final String xml = "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
     + "<exampleXmlElement><name>Test</name></exampleXmlElement>";
 final ExampleXmlElement object = XmlUtil.unmarshal(new UnmarshalParameters.Builder(xml, ExampleXmlElement).build());
 

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

See Also:

XmlUtil.unmarshal(UnmarshalParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnmarshalParameters.Builder<T> Builder class that builds UnmarshalParameters objects.

Constructor Summary

Constructors

Constructor and Description
UnmarshalParameters(UnmarshalParameters.Builder<T> builder) Constructs this UnmarshalParameters object from the supplied builder.

Method Summary

Modifier and Type	Method and Description
JAXBContext	getJaxbContext() Gets the optional JAXB context.
Map<String,Object>	getPoperties() Gets the unmarshalling properties.
Class	getType() Gets the type of object to unmarshal to.
String	getXml() Gets the XML to unmarshal.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnmarshalParameters

public UnmarshalParameters(UnmarshalParameters.Builder<T> builder)

Constructs this UnmarshalParameters object from the supplied builder.

Type Parameters:

T - The type of the object to unmarshal to.

Parameters:

builder - The builder to create this UnmarshalParameters object from.

Method Detail

getXml

public String getXml()

Gets the XML to unmarshal.

Returns:

The XML to unmarshal.

getType

public Class getType()

Gets the type of object to unmarshal to.

Returns:

The type of object to unmarshal to.

getJaxbContext

public JAXBContext getJaxbContext()

Gets the optional JAXB context.

Returns:

The optional JAXB context.

getPoperties

public Map<String,Object> getPoperties()

Gets the unmarshalling properties.

Returns:

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