org.josef.util.xml

Class MarshalParameters.Builder

java.lang.Object

org.josef.util.xml.MarshalParameters.Builder

All Implemented Interfaces:

Builder<MarshalParameters>

Enclosing class:

MarshalParameters

public static class MarshalParameters.Builder
extends Object
implements Builder<MarshalParameters>

Builder class that builds MarshalParameters objects.

Author:

Kees Schotanus.

Constructor Summary

Constructors

Constructor and Description
Builder(Object object) Creates this Builder using the supplied object and using default settings.

Method Summary

Modifier and Type	Method and Description
MarshalParameters	build() Builds the MarshalParameters object.
MarshalParameters.Builder	escape(boolean escape) Adds the escape option.
MarshalParameters.Builder	jaxbContext(JAXBContext jaxbContext) Adds the JAXB context used for marshalling.
MarshalParameters.Builder	property(String propertyName, Object propertyValue) Adds a marshalling property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Object object)

Creates this Builder using the supplied object and using default settings.

Parameters:

object - The object to marshal.

Method Detail

jaxbContext

public MarshalParameters.Builder jaxbContext(JAXBContext jaxbContext)

Adds the JAXB context used for marshalling.

Parameters:

jaxbContext - The JAXB context.

Returns:

This Builder.

escape

public MarshalParameters.Builder escape(boolean escape)

Adds the escape option.

Parameters:

escape - True to escape, false to not escape the XML.

Returns:

This Builder.

property

public MarshalParameters.Builder property(String propertyName,
                                          Object propertyValue)

Adds a marshalling property.

Parameters:

propertyName - The name of the marshalling property.

propertyValue - The value of the marshalling property.

Returns:

This Builder.

Throws:

NullPointerException - When either the supplied propertyName or propertyValue is null.

IllegalArgumentException - When the supplied propertyName is empty.

build

public MarshalParameters build()

Builds the MarshalParameters object.

Specified by:

build in interface Builder<MarshalParameters>

Returns:

The build MarshalParameters object.