com.helger.jaxb.builder

Class JAXBWriterBuilder<JAXBTYPE,IMPLTYPE extends JAXBWriterBuilder<JAXBTYPE,IMPLTYPE>>

java.lang.Object

com.helger.jaxb.builder.AbstractJAXBBuilder<IMPLTYPE>

com.helger.jaxb.builder.AbstractWritingJAXBBuilder<JAXBTYPE,IMPLTYPE>

com.helger.jaxb.builder.JAXBWriterBuilder<JAXBTYPE,IMPLTYPE>

Type Parameters:

JAXBTYPE - The JAXB implementation class to be written

IMPLTYPE - The implementation class implementing this abstract class.

All Implemented Interfaces:

com.helger.commons.lang.IHasClassLoader, com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, IJAXBWriter<JAXBTYPE>

@NotThreadSafe
public class JAXBWriterBuilder<JAXBTYPE,IMPLTYPE extends JAXBWriterBuilder<JAXBTYPE,IMPLTYPE>>
extends AbstractWritingJAXBBuilder<JAXBTYPE,IMPLTYPE>
implements IJAXBWriter<JAXBTYPE>

Builder class for writing JAXB documents.

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.jaxb.IJAXBWriter

IJAXBWriter.IJAXBMarshaller<JAXBTYPE>

Field Summary

Fields inherited from class com.helger.jaxb.builder.AbstractJAXBBuilder

m_aDocType

Fields inherited from interface com.helger.jaxb.IJAXBWriter

USE_JAXB_CHARSET_FIX

Constructor Summary

Constructors

Constructor and Description
JAXBWriterBuilder(IJAXBDocumentType aDocType)

Method Summary

Modifier and Type	Method and Description
protected Marshaller	createMarshaller() Create the main marshaller with the contained settings.
Charset	getCharset()
String	getIndentString()
NamespaceContext	getNamespaceContext()
String	getNoNamespaceSchemaLocation()
String	getSchemaLocation()
ValidationEventHandler	getValidationEventHandler()
boolean	isFormattedOutput()
IMPLTYPE	setCharset(Charset aCharset) Set the charset to be used for writing JAXB objects.
IMPLTYPE	setFormattedOutput(boolean bFormattedOutput) Enable or disable the formatting of the output.
IMPLTYPE	setIndentString(String sIndentString) Set the indent string to be used for writing JAXB objects.
IMPLTYPE	setNamespaceContext(NamespaceContext aNSContext) Set the namespace context (prefix to namespace URL mapping) to be used.
IMPLTYPE	setNoNamespaceSchemaLocation(String sNoNamespaceSchemaLocation) Set the no namespace Schema Location to be used for writing JAXB objects.
IMPLTYPE	setSchemaLocation(String sSchemaLocation) Set the Schema Location to be used for writing JAXB objects.
IMPLTYPE	setValidationEventHandler(ValidationEventHandler aEventHandler) Set the JAXB validation event handler to be used.
String	toString()
com.helger.commons.state.ESuccess	write(JAXBTYPE aJAXBDocument, IJAXBWriter.IJAXBMarshaller<JAXBTYPE> aMarshallerFunc) Convert the passed object to XML.

Methods inherited from class com.helger.jaxb.builder.AbstractWritingJAXBBuilder

createJAXBElement, getMarshallerCustomizer, setMarshallerCustomizer

Methods inherited from class com.helger.jaxb.builder.AbstractJAXBBuilder

exceptionCallbacks, getClassLoader, getJAXBContext, getJAXBDocumentType, getSchema, isUseJAXBContextCache, isUseSchema, setUseJAXBContextCache, setUseSchema

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.jaxb.IJAXBWriter

getAsByteBuffer, getAsBytes, getAsDocument, getAsInputStream, getAsMicroDocument, getAsMicroElement, getAsString, getXMLWriterSettings, hasCharset, hasIndentString, hasNoNamespaceSchemaLocation, hasSchemaLocation, write, write, write, write, write, write, write, write, write

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.lang.IHasClassLoader

hasClassLoader

Constructor Detail

JAXBWriterBuilder

public JAXBWriterBuilder(@Nonnull
                         IJAXBDocumentType aDocType)

Method Detail

getValidationEventHandler

@Nullable
public ValidationEventHandler getValidationEventHandler()

Returns:

The special JAXB validation event handler to be used. By default JAXBBuilderDefaultSettings.getDefaultValidationEventHandler() is used.

setValidationEventHandler

@Nonnull
public final IMPLTYPE setValidationEventHandler(@Nullable
                                                          ValidationEventHandler aEventHandler)

Set the JAXB validation event handler to be used. May be null.

Parameters:

aEventHandler - The event handler to be used. May be null.

Returns:

this for chaining

getNamespaceContext

@Nullable
public NamespaceContext getNamespaceContext()

Specified by:

getNamespaceContext in interface IJAXBWriter<JAXBTYPE>

Returns:

The special JAXB namespace context to be used. By default JAXBBuilderDefaultSettings.getDefaultNamespaceContext() is used.

setNamespaceContext

@Nonnull
public final IMPLTYPE setNamespaceContext(@Nullable
                                                    NamespaceContext aNSContext)

Set the namespace context (prefix to namespace URL mapping) to be used.

Parameters:

aNSContext - The namespace context to be used. May be null.

Returns:

this for chaining

isFormattedOutput

public boolean isFormattedOutput()

Specified by:

isFormattedOutput in interface IJAXBWriter<JAXBTYPE>

Returns:

true if the JAXB output should be formatted. Default is false.

setFormattedOutput

@Nonnull
public final IMPLTYPE setFormattedOutput(boolean bFormattedOutput)

Enable or disable the formatting of the output.

Parameters:

bFormattedOutput - true to enable it, false to disable it.

Returns:

this for chaining

getCharset

@Nullable
public Charset getCharset()

Specified by:

getCharset in interface IJAXBWriter<JAXBTYPE>

Returns:

The special JAXB Charset to be used for writing. null by default.

setCharset

@Nonnull
public final IMPLTYPE setCharset(@Nullable
                                           Charset aCharset)

Set the charset to be used for writing JAXB objects.

Parameters:

aCharset - The charset to be used by default. May be null.

Returns:

this for chaining

getIndentString

@Nullable
public String getIndentString()

Specified by:

getIndentString in interface IJAXBWriter<JAXBTYPE>

Returns:

The JAXB indentation string to be used for writing. null by default. Only used when formatted output is used.

setIndentString

@Nonnull
public final IMPLTYPE setIndentString(@Nullable
                                                String sIndentString)

Set the indent string to be used for writing JAXB objects.

Parameters:

sIndentString - The indent string to be used. May be null.

Returns:

this for chaining

getSchemaLocation

@Nullable
public String getSchemaLocation()

Specified by:

getSchemaLocation in interface IJAXBWriter<JAXBTYPE>

Returns:

The schema location to be used for writing. null by default.

setSchemaLocation

@Nonnull
public final IMPLTYPE setSchemaLocation(@Nullable
                                                  String sSchemaLocation)

Set the Schema Location to be used for writing JAXB objects.

Parameters:

sSchemaLocation - The Schema Location to be used. May be null.

Returns:

this for chaining

Since:

8.6.0

getNoNamespaceSchemaLocation

@Nullable
public String getNoNamespaceSchemaLocation()

Specified by:

getNoNamespaceSchemaLocation in interface IJAXBWriter<JAXBTYPE>

Returns:

The no namespace schema location to be used for writing. null by default.

setNoNamespaceSchemaLocation

@Nonnull
public final IMPLTYPE setNoNamespaceSchemaLocation(@Nullable
                                                             String sNoNamespaceSchemaLocation)

Set the no namespace Schema Location to be used for writing JAXB objects.

Parameters:

sNoNamespaceSchemaLocation - The no namespace Schema Location to be used. May be null.

Returns:

this for chaining

Since:

9.0.0

createMarshaller

@Nonnull
protected Marshaller createMarshaller()
                                         throws JAXBException

Description copied from class: AbstractWritingJAXBBuilder

Create the main marshaller with the contained settings.

Overrides:

createMarshaller in class AbstractWritingJAXBBuilder<JAXBTYPE,IMPLTYPE extends JAXBWriterBuilder<JAXBTYPE,IMPLTYPE>>

Returns:

The Marshaller and never null.

Throws:

JAXBException - In case creation fails

write

@Nonnull
public com.helger.commons.state.ESuccess write(@Nonnull
                                                         JAXBTYPE aJAXBDocument,
                                                         @Nonnull
                                                         IJAXBWriter.IJAXBMarshaller<JAXBTYPE> aMarshallerFunc)

Description copied from interface: IJAXBWriter

Convert the passed object to XML.

Specified by:

write in interface IJAXBWriter<JAXBTYPE>

Parameters:

aJAXBDocument - The object to be converted. May not be null.

aMarshallerFunc - The marshalling function. May not be null.

Returns:

ESuccess

toString

public String toString()

Overrides:

toString in class AbstractJAXBBuilder<IMPLTYPE extends JAXBWriterBuilder<JAXBTYPE,IMPLTYPE>>