com.helger.commons.xml.serialize.read

Class DOMReaderSettings

java.lang.Object

com.helger.commons.xml.serialize.read.DOMReaderSettings

All Implemented Interfaces:

ICloneable<DOMReaderSettings>, IBaseXMLReaderSettings, IDOMReaderSettings

@NotThreadSafe
public class DOMReaderSettings
extends Object
implements ICloneable<DOMReaderSettings>, IDOMReaderSettings

DOM reader settings

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
DOMReaderSettings() Constructor using the default settings from DOMReaderDefaultSettings.
DOMReaderSettings(IDOMReaderSettings aOther) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	applyToDocumentBuilder(DocumentBuilder aDocumentBuilder) Apply settings of this object onto the specified DocumentBuilder object.
void	applyToDocumentBuilderFactory(DocumentBuilderFactory aDocumentBuilderFactory) Apply settings of this object onto the specified DocumentBuilderFactory object.
ICommonsMap<EXMLParserFeature,Boolean>	getAllFeatureValues()
ICommonsMap<EXMLParserProperty,Object>	getAllPropertyValues()
DOMReaderSettings	getClone()
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
IExceptionCallback<Throwable>	getExceptionHandler()
Boolean	getFeatureValue(EXMLParserFeature eFeature) Get the value of the specified parser feature
Locale	getLocale()
Object	getPropertyValue(EXMLParserProperty eProperty) Get the value of the specified parser property
Schema	getSchema()
boolean	hasAnyFeature()
boolean	hasAnyProperties()
boolean	isCoalescing()
boolean	isExpandEntityReferences()
boolean	isIgnoringComments()
boolean	isIgnoringElementContentWhitespace()
boolean	isNamespaceAware()
boolean	isRequiresNewXMLParserExplicitly()
boolean	isValidating()
boolean	isXIncludeAware()
EChange	removeAllFeatures()
EChange	removeAllPropertyValues()
EChange	removeFeature(EXMLParserFeature eFeature)
EChange	removePropertyValue(EXMLParserProperty eProperty)
boolean	requiresNewXMLParser() Check if the current settings require a separate DocumentBuilderFactory or if a pooled default object can be used.
DOMReaderSettings	setCoalescing(boolean bCoalescing)
DOMReaderSettings	setEntityResolver(EntityResolver aEntityResolver)
DOMReaderSettings	setErrorHandler(ErrorHandler aErrorHandler)
DOMReaderSettings	setExceptionHandler(IExceptionCallback<Throwable> aExceptionHandler)
DOMReaderSettings	setExpandEntityReferences(boolean bExpandEntityReferences)
DOMReaderSettings	setFeatureValue(EXMLParserFeature eFeature, boolean bValue)
DOMReaderSettings	setFeatureValue(EXMLParserFeature eFeature, Boolean aValue)
DOMReaderSettings	setFeatureValues(Map<EXMLParserFeature,Boolean> aValues)
DOMReaderSettings	setIgnoringComments(boolean bIgnoringComments)
DOMReaderSettings	setIgnoringElementContentWhitespace(boolean bIgnoringElementContentWhitespace)
DOMReaderSettings	setLocale(Locale aLocale)
DOMReaderSettings	setNamespaceAware(boolean bNamespaceAware)
DOMReaderSettings	setPropertyValue(EXMLParserProperty eProperty, Object aPropertyValue)
DOMReaderSettings	setPropertyValues(Map<EXMLParserProperty,?> aProperties)
DOMReaderSettings	setRequiresNewXMLParserExplicitly(boolean bRequiresNewXMLParserExplicitly)
DOMReaderSettings	setSchema(Schema aSchema)
DOMReaderSettings	setValidating(boolean bValidating)
DOMReaderSettings	setXIncludeAware(boolean bXIncludeAware)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DOMReaderSettings

public DOMReaderSettings()

Constructor using the default settings from DOMReaderDefaultSettings.

DOMReaderSettings

public DOMReaderSettings(@Nonnull
                         IDOMReaderSettings aOther)

Copy constructor.

Parameters:

aOther - The settings object to copy from. May not be null.

Method Detail

isNamespaceAware

public boolean isNamespaceAware()

Specified by:

isNamespaceAware in interface IDOMReaderSettings

Returns:

true if the parser should be namespace aware, false if not.

setNamespaceAware

@Nonnull
public final DOMReaderSettings setNamespaceAware(boolean bNamespaceAware)

isValidating

public boolean isValidating()

Specified by:

isValidating in interface IDOMReaderSettings

Returns:

true if the parser should be validating, false if not.

setValidating

@Nonnull
public final DOMReaderSettings setValidating(boolean bValidating)

isIgnoringElementContentWhitespace

public boolean isIgnoringElementContentWhitespace()

Specified by:

isIgnoringElementContentWhitespace in interface IDOMReaderSettings

Returns:

true if the parser should be element content whitespace ignoring, false if not.

setIgnoringElementContentWhitespace

@Nonnull
public final DOMReaderSettings setIgnoringElementContentWhitespace(boolean bIgnoringElementContentWhitespace)

isExpandEntityReferences

public boolean isExpandEntityReferences()

Specified by:

isExpandEntityReferences in interface IDOMReaderSettings

Returns:

true if the parser should expand entity references, false if not.

setExpandEntityReferences

@Nonnull
public final DOMReaderSettings setExpandEntityReferences(boolean bExpandEntityReferences)

isIgnoringComments

public boolean isIgnoringComments()

Specified by:

isIgnoringComments in interface IDOMReaderSettings

Returns:

true if the parser should ignore comments, false if not.

setIgnoringComments

@Nonnull
public final DOMReaderSettings setIgnoringComments(boolean bIgnoringComments)

isCoalescing

public boolean isCoalescing()

Specified by:

isCoalescing in interface IDOMReaderSettings

Returns:

true if the parser should read CDATA as text, false if not.

setCoalescing

@Nonnull
public final DOMReaderSettings setCoalescing(boolean bCoalescing)

getSchema

@Nullable
public Schema getSchema()

Specified by:

getSchema in interface IDOMReaderSettings

Returns:

A special XML schema to be used or null if none should be used.

setSchema

@Nonnull
public final DOMReaderSettings setSchema(@Nullable
                                                   Schema aSchema)

isXIncludeAware

public boolean isXIncludeAware()

Specified by:

isXIncludeAware in interface IDOMReaderSettings

Returns:

true if the parser should be XInclude aware, false if not.

setXIncludeAware

@Nonnull
public final DOMReaderSettings setXIncludeAware(boolean bXIncludeAware)

hasAnyProperties

public boolean hasAnyProperties()

Specified by:

hasAnyProperties in interface IBaseXMLReaderSettings

Returns:

true if at least one parser property is defined

getPropertyValue

@Nullable
public Object getPropertyValue(@Nullable
                                          EXMLParserProperty eProperty)

Description copied from interface: IBaseXMLReaderSettings

Get the value of the specified parser property

Specified by:

getPropertyValue in interface IBaseXMLReaderSettings

Parameters:

eProperty - The property to use. May be null.

Returns:

null if no such property was found.

getAllPropertyValues

@Nonnull
 @ReturnsMutableCopy
public ICommonsMap<EXMLParserProperty,Object> getAllPropertyValues()

Specified by:

getAllPropertyValues in interface IBaseXMLReaderSettings

Returns:

A copy of all contained parser property values. Never null.

setPropertyValue

@Nonnull
public final DOMReaderSettings setPropertyValue(@Nonnull
                                                          EXMLParserProperty eProperty,
                                                          @Nullable
                                                          Object aPropertyValue)

setPropertyValues

@Nonnull
public final DOMReaderSettings setPropertyValues(@Nullable
                                                           Map<EXMLParserProperty,?> aProperties)

removePropertyValue

@Nonnull
public final EChange removePropertyValue(@Nullable
                                                   EXMLParserProperty eProperty)

removeAllPropertyValues

@Nonnull
public final EChange removeAllPropertyValues()

getLocale

@Nullable
public Locale getLocale()

Specified by:

getLocale in interface IBaseXMLReaderSettings

Returns:

The locale to be used for error messages. By default it is null and therefore the XML parser will use the system default locale.

setLocale

public DOMReaderSettings setLocale(@Nullable
                                   Locale aLocale)

hasAnyFeature

public boolean hasAnyFeature()

Specified by:

hasAnyFeature in interface IBaseXMLReaderSettings

Returns:

true if at least one parser feature is defined, false if not

getFeatureValue

@Nullable
public Boolean getFeatureValue(@Nullable
                                          EXMLParserFeature eFeature)

Description copied from interface: IBaseXMLReaderSettings

Get the value of the specified parser feature

Specified by:

getFeatureValue in interface IBaseXMLReaderSettings

Parameters:

eFeature - The feature to search. May be null.

Returns:

null if this feature is undefined.

getAllFeatureValues

@Nonnull
 @ReturnsMutableCopy
public ICommonsMap<EXMLParserFeature,Boolean> getAllFeatureValues()

Specified by:

getAllFeatureValues in interface IBaseXMLReaderSettings

Returns:

A copy of all defined parser features at the associated values.

setFeatureValue

@Nonnull
public final DOMReaderSettings setFeatureValue(@Nonnull
                                                         EXMLParserFeature eFeature,
                                                         boolean bValue)

setFeatureValue

@Nonnull
public final DOMReaderSettings setFeatureValue(@Nonnull
                                                         EXMLParserFeature eFeature,
                                                         @Nullable
                                                         Boolean aValue)

setFeatureValues

@Nonnull
public final DOMReaderSettings setFeatureValues(@Nullable
                                                          Map<EXMLParserFeature,Boolean> aValues)

removeFeature

@Nonnull
public final EChange removeFeature(@Nullable
                                             EXMLParserFeature eFeature)

removeAllFeatures

@Nonnull
public final EChange removeAllFeatures()

requiresNewXMLParser

public boolean requiresNewXMLParser()

Description copied from interface: IDOMReaderSettings

Check if the current settings require a separate DocumentBuilderFactory or if a pooled default object can be used.

Specified by:

requiresNewXMLParser in interface IBaseXMLReaderSettings

Specified by:

requiresNewXMLParser in interface IDOMReaderSettings

Returns:

true if a separate DocumentBuilderFactory is required, false if not.

getEntityResolver

@Nullable
public EntityResolver getEntityResolver()

Specified by:

getEntityResolver in interface IBaseXMLReaderSettings

Returns:

The special entity resolver to be used. May be null.

setEntityResolver

@Nonnull
public final DOMReaderSettings setEntityResolver(@Nullable
                                                           EntityResolver aEntityResolver)

getErrorHandler

@Nullable
public ErrorHandler getErrorHandler()

Specified by:

getErrorHandler in interface IBaseXMLReaderSettings

Returns:

A special error handler to be used or null if no special error handler is needed.

setErrorHandler

@Nonnull
public final DOMReaderSettings setErrorHandler(@Nullable
                                                         ErrorHandler aErrorHandler)

getExceptionHandler

@Nonnull
public IExceptionCallback<Throwable> getExceptionHandler()

Specified by:

getExceptionHandler in interface IBaseXMLReaderSettings

Returns:

A special exception handler to be used. Never null.

setExceptionHandler

@Nonnull
public final DOMReaderSettings setExceptionHandler(@Nonnull
                                                             IExceptionCallback<Throwable> aExceptionHandler)

isRequiresNewXMLParserExplicitly

public boolean isRequiresNewXMLParserExplicitly()

Specified by:

isRequiresNewXMLParserExplicitly in interface IDOMReaderSettings

Returns:

true if a new XML parser is explicitly required for this instance.

setRequiresNewXMLParserExplicitly

@Nonnull
public final DOMReaderSettings setRequiresNewXMLParserExplicitly(boolean bRequiresNewXMLParserExplicitly)

getClone

@Nonnull
public DOMReaderSettings getClone()

Specified by:

getClone in interface ICloneable<DOMReaderSettings>

Returns:

A 100% deep-copy of the implementing class.

applyToDocumentBuilderFactory

public void applyToDocumentBuilderFactory(@Nonnull
                                          DocumentBuilderFactory aDocumentBuilderFactory)

Description copied from interface: IDOMReaderSettings

Apply settings of this object onto the specified DocumentBuilderFactory object.

Specified by:

applyToDocumentBuilderFactory in interface IDOMReaderSettings

Parameters:

aDocumentBuilderFactory - The DocumentBuilderFactory to apply the settings onto. May not be null.

applyToDocumentBuilder

public void applyToDocumentBuilder(@Nonnull
                                   DocumentBuilder aDocumentBuilder)

Description copied from interface: IDOMReaderSettings

Apply settings of this object onto the specified DocumentBuilder object.

Specified by:

applyToDocumentBuilder in interface IDOMReaderSettings

Parameters:

aDocumentBuilder - The DocumentBuilder to apply the settings onto. May not be null.

toString

public String toString()

Overrides:

toString in class Object