com.helger.jaxb.builder

Class AbstractJAXBBuilder<IMPLTYPE extends AbstractJAXBBuilder<IMPLTYPE>>

java.lang.Object

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

Type Parameters:

IMPLTYPE - The implementation class implementing this abstract class.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractWritingJAXBBuilder, JAXBReaderBuilder

@NotThreadSafe
public abstract class AbstractJAXBBuilder<IMPLTYPE extends AbstractJAXBBuilder<IMPLTYPE>>
extends Object
implements com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.lang.IHasClassLoader

Abstract builder class for reading, writing and validating JAXB documents.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
protected IJAXBDocumentType	m_aDocType

Constructor Summary

Constructors

Constructor and Description
AbstractJAXBBuilder(IJAXBDocumentType aDocType)

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader()
protected JAXBContext	getJAXBContext()
IJAXBDocumentType	getJAXBDocumentType()
protected Schema	getSchema()
boolean	isUseJAXBContextCache()
boolean	isUseSchema()
IMPLTYPE	setClassLoader(ClassLoader aClassLoader) Deprecated.
IMPLTYPE	setUseJAXBContextCache(boolean bUseJAXBContextCache) Set usage of the JAXBContextCache.
IMPLTYPE	setUseSchema(boolean bUseSchema) Set usage of XML Schema.
String	toString()

Methods inherited from class java.lang.Object

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

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

thisAsT

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

hasClassLoader

Field Detail

m_aDocType

protected final IJAXBDocumentType m_aDocType

Constructor Detail

AbstractJAXBBuilder

public AbstractJAXBBuilder(@Nonnull
                           IJAXBDocumentType aDocType)

Method Detail

getJAXBDocumentType

@Nonnull
public final IJAXBDocumentType getJAXBDocumentType()

Returns:

The document type as passed in the constructor. Never null.

getClassLoader

@Nullable
public final ClassLoader getClassLoader()

Specified by:

getClassLoader in interface com.helger.commons.lang.IHasClassLoader

Returns:

The special class loader to be used. null by default.

setClassLoader

@Nonnull
 @Deprecated
 @DevelopersNote(value="Deprecated since v9.0.0")
public final IMPLTYPE setClassLoader(@Nullable
                                                                                                                ClassLoader aClassLoader)

Deprecated.

Set the class loader to be used. This is optional. Since v9.0.0 a class loader is set by default, so this method is most likely not needed anymore!

Parameters:

aClassLoader - The class loader to be used. May be null.

Returns:

this

isUseJAXBContextCache

public final boolean isUseJAXBContextCache()

Returns:

true if the JAXBContextCache is used, false if not. Default is true.

setUseJAXBContextCache

@Nonnull
public final IMPLTYPE setUseJAXBContextCache(boolean bUseJAXBContextCache)

Set usage of the JAXBContextCache. For performance reasons it's recommended to use the cache.

Parameters:

bUseJAXBContextCache - true to use the cache, false to create a new JAXBContext every time.

Returns:

this

isUseSchema

public final boolean isUseSchema()

Returns:

true if the XML Schema should be used to validate on unmarshalling, false if not. Default is true.

Since:

9.0.3

setUseSchema

@Nonnull
public final IMPLTYPE setUseSchema(boolean bUseSchema)

Set usage of XML Schema. By default it is enabled, but for rare cases it could make sense to disable validation e.g. because of performance reasons.

Parameters:

bUseSchema - true to use XML Schema, false to not do it.

Returns:

this

Since:

9.0.3

getSchema

@Nullable
protected final Schema getSchema()

Returns:

The XML schema to be used for validating instances. May be null if no XSDs are present. Also null if

getJAXBContext

@Nonnull
 @OverrideOnDemand
protected JAXBContext getJAXBContext()
                                                            throws JAXBException

Throws:

JAXBException

toString

public String toString()

Overrides:

toString in class Object