com.helger.jaxb.builder

Class JAXBReaderBuilder<JAXBTYPE,IMPLTYPE extends JAXBReaderBuilder<JAXBTYPE,IMPLTYPE>>

java.lang.Object

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

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

Type Parameters:

JAXBTYPE - The JAXB implementation class to be read

IMPLTYPE - The implementation class implementing this abstract class.

All Implemented Interfaces:

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

@NotThreadSafe
public class JAXBReaderBuilder<JAXBTYPE,IMPLTYPE extends JAXBReaderBuilder<JAXBTYPE,IMPLTYPE>>
extends AbstractJAXBBuilder<IMPLTYPE>
implements IJAXBReader<JAXBTYPE>

Builder class for reading JAXB documents.

Author:

Philip Helger

Nested Class Summary

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

IJAXBReader.IJAXBUnmarshaller<JAXBTYPE>

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_READ_SECURE

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

m_aDocType

Constructor Summary

Constructors

Constructor and Description
JAXBReaderBuilder(IJAXBDocumentType aDocType)
JAXBReaderBuilder(IJAXBDocumentType aDocType, Class<JAXBTYPE> aImplClass)

Method Summary

Modifier and Type	Method and Description
protected Unmarshaller	createUnmarshaller()
protected Class<JAXBTYPE>	getImplClass()
Consumer<? super Unmarshaller>	getUnmarshallerCustomizer()
ValidationEventHandler	getValidationEventHandler()
boolean	isReadSecure() Check if secure reading is enabled.
JAXBTYPE	read(IJAXBReader.IJAXBUnmarshaller<JAXBTYPE> aHandler) Read a document using the passed handler.
IMPLTYPE	setReadSecure(boolean bReadSecure)
IMPLTYPE	setUnmarshallerCustomizer(Consumer<? super Unmarshaller> aUnmarshallerCustomizer)
IMPLTYPE	setValidationEventHandler(ValidationEventHandler aEventHandler) Set the JAXB validation event handler to be used.
String	toString()

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.IJAXBReader

read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read, read

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

thisAsT

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

hasClassLoader

Field Detail

DEFAULT_READ_SECURE

public static final boolean DEFAULT_READ_SECURE

See Also:

Constant Field Values

Constructor Detail

JAXBReaderBuilder

public JAXBReaderBuilder(@Nonnull
                         IJAXBDocumentType aDocType)

JAXBReaderBuilder

public JAXBReaderBuilder(@Nonnull
                         IJAXBDocumentType aDocType,
                         @Nonnull
                         Class<JAXBTYPE> aImplClass)

Method Detail

getImplClass

@Nonnull
protected final Class<JAXBTYPE> getImplClass()

getValidationEventHandler

@Nullable
public final 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

getUnmarshallerCustomizer

@Nullable
public final Consumer<? super Unmarshaller> getUnmarshallerCustomizer()

setUnmarshallerCustomizer

@Nonnull
public final IMPLTYPE setUnmarshallerCustomizer(@Nullable
                                                          Consumer<? super Unmarshaller> aUnmarshallerCustomizer)

isReadSecure

public final boolean isReadSecure()

Description copied from interface: IJAXBReader

Check if secure reading is enabled. Secure reading means that documents are checked for XXE and XML bombs (infinite entity expansions). By default secure reading is enabled.

Specified by:

isReadSecure in interface IJAXBReader<JAXBTYPE>

Returns:

true if secure reading is enabled.

setReadSecure

@Nonnull
public final IMPLTYPE setReadSecure(boolean bReadSecure)

createUnmarshaller

@Nonnull
protected Unmarshaller createUnmarshaller()
                                             throws JAXBException

Throws:

JAXBException

read

@Nullable
public JAXBTYPE read(@Nonnull
                                IJAXBReader.IJAXBUnmarshaller<JAXBTYPE> aHandler)

Description copied from interface: IJAXBReader

Read a document using the passed handler.

Specified by:

read in interface IJAXBReader<JAXBTYPE>

Parameters:

aHandler - The unmarshalling handler. May not be null.

Returns:

null in case reading fails.

toString

public String toString()

Overrides:

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