Package com.helger.xml.serialize.read

Class SAXReaderSettings

java.lang.Object

com.helger.xml.serialize.read.SAXReaderSettings

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<SAXReaderSettings>, IBaseXMLReaderSettings, ISAXReaderSettings

@NotThreadSafe
public class SAXReaderSettings
extends Object
implements ISAXReaderSettings, com.helger.commons.lang.ICloneable<SAXReaderSettings>

SAX reader settings

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
SAXReaderSettings()	Default constructor
SAXReaderSettings(ISAXReaderSettings aOther)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	applyToSAXReader(XMLReader aParser)	Apply all settings of this object onto the specified XMLReader object
static SAXReaderSettings	createCloneOnDemand(ISAXReaderSettings aOther)	Create a clone of the passed settings, depending on the parameter.
com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<Throwable>>	exceptionCallbacks()
com.helger.commons.collection.impl.ICommonsMap<EXMLParserFeature,Boolean>	getAllFeatureValues()
com.helger.commons.collection.impl.ICommonsMap<EXMLParserProperty,Object>	getAllPropertyValues()
SAXReaderSettings	getClone()
ContentHandler	getContentHandler()
SAXParserFactory	getCustomSAXParserFactory()
DeclHandler	getDeclarationHandler()
DTDHandler	getDTDHandler()
EntityResolver	getEntityResolver()
ErrorHandler	getErrorHandler()
Boolean	getFeatureValue(EXMLParserFeature eFeature)	Get the value of the specified parser feature
LexicalHandler	getLexicalHandler()
Locale	getLocale()
Object	getPropertyValue(EXMLParserProperty eProperty)	Get the value of the specified parser property
boolean	hasAnyFeature()
boolean	hasAnyProperties()
boolean	isRequiresNewXMLParserExplicitly()
final SAXReaderSettings	removeAllFeatures()
final SAXReaderSettings	removeAllPropertyValues()
final SAXReaderSettings	removeFeature(EXMLParserFeature eFeature)
final SAXReaderSettings	removeFeatures(EXMLParserFeature... aFeatures)
final SAXReaderSettings	removePropertyValue(EXMLParserProperty eProperty)
boolean	requiresNewXMLParser()	Check if the current settings require a separate XMLReader or if a pooled default object can be used.
final SAXReaderSettings	setContentHandler(ContentHandler aContentHandler)
final SAXReaderSettings	setCustomSAXParserFactory(SAXParserFactory aCustomSAXParserFactory)
final SAXReaderSettings	setDeclarationHandler(DeclHandler aDeclHandler)
final SAXReaderSettings	setDTDHandler(DTDHandler aDTDHandler)
final SAXReaderSettings	setEntityResolver(EntityResolver aEntityResolver)
final SAXReaderSettings	setErrorHandler(ErrorHandler aErrorHandler)
final SAXReaderSettings	setFeatureValue(EXMLParserFeature eFeature, boolean bValue)
final SAXReaderSettings	setFeatureValue(EXMLParserFeature eFeature, Boolean aValue)
final SAXReaderSettings	setFeatureValues(Map<EXMLParserFeature,Boolean> aValues)	Add multiple XML parser features at once.
final SAXReaderSettings	setLexicalHandler(LexicalHandler aLexicalHandler)
SAXReaderSettings	setLocale(Locale aLocale)
final SAXReaderSettings	setPropertyValue(EXMLParserProperty eProperty, Object aPropertyValue)
final SAXReaderSettings	setPropertyValues(Map<EXMLParserProperty,?> aProperties)
final SAXReaderSettings	setRequiresNewXMLParserExplicitly(boolean bRequiresNewXMLParserExplicitly)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

SAXReaderSettings

public SAXReaderSettings()

Default constructor

SAXReaderSettings

public SAXReaderSettings(@Nonnull
 ISAXReaderSettings aOther)

Copy constructor

Parameters:

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

Method Details

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 SAXReaderSettings setEntityResolver(@Nullable
 EntityResolver aEntityResolver)

getDTDHandler

@Nullable
public DTDHandler getDTDHandler()

Specified by:

getDTDHandler in interface ISAXReaderSettings

Returns:

The special DTD handler to be used. May be null.

setDTDHandler

@Nonnull
public final SAXReaderSettings setDTDHandler(@Nullable
 DTDHandler aDTDHandler)

getContentHandler

@Nullable
public ContentHandler getContentHandler()

Specified by:

getContentHandler in interface ISAXReaderSettings

Returns:

The special content handler to be used. May be null.

setContentHandler

@Nonnull
public final SAXReaderSettings setContentHandler(@Nullable
 ContentHandler aContentHandler)

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 SAXReaderSettings setErrorHandler(@Nullable
 ErrorHandler aErrorHandler)

getLexicalHandler

@Nullable
public LexicalHandler getLexicalHandler()

Specified by:

getLexicalHandler in interface ISAXReaderSettings

Returns:

The special lexical handler to be used. May be null.

setLexicalHandler

@Nonnull
public final SAXReaderSettings setLexicalHandler(@Nullable
 LexicalHandler aLexicalHandler)

getDeclarationHandler

@Nullable
public DeclHandler getDeclarationHandler()

Specified by:

getDeclarationHandler in interface ISAXReaderSettings

Returns:

The special DTD declaration event handler to be used. May be null.

setDeclarationHandler

@Nonnull
public final SAXReaderSettings setDeclarationHandler(@Nullable
 DeclHandler aDeclHandler)

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 com.helger.commons.collection.impl.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 SAXReaderSettings setPropertyValue(@Nonnull
 EXMLParserProperty eProperty,
 @Nullable
 Object aPropertyValue)

setPropertyValues

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

removePropertyValue

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

removeAllPropertyValues

@Nonnull
public final SAXReaderSettings 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

@Nonnull
public SAXReaderSettings 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 com.helger.commons.collection.impl.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 SAXReaderSettings setFeatureValue(@Nonnull
 EXMLParserFeature eFeature,
 boolean bValue)

setFeatureValue

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

setFeatureValues

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

Add multiple XML parser features at once.

Parameters:

aValues - The values to be added. May be null.

Returns:

this for chaining

removeFeature

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

removeFeatures

@Nonnull
public final SAXReaderSettings removeFeatures(@Nullable
 EXMLParserFeature... aFeatures)

removeAllFeatures

@Nonnull
public final SAXReaderSettings removeAllFeatures()

requiresNewXMLParser

public boolean requiresNewXMLParser()

Description copied from interface: ISAXReaderSettings

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

Specified by:

requiresNewXMLParser in interface IBaseXMLReaderSettings

Specified by:

requiresNewXMLParser in interface ISAXReaderSettings

Returns:

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

exceptionCallbacks

@Nonnull
@ReturnsMutableObject
public com.helger.commons.callback.CallbackList<com.helger.commons.callback.exception.IExceptionCallback<Throwable>> exceptionCallbacks()

Specified by:

exceptionCallbacks in interface IBaseXMLReaderSettings

Returns:

A special exception handler to be used. Never null.

getCustomSAXParserFactory

@Nullable
public SAXParserFactory getCustomSAXParserFactory()

Specified by:

getCustomSAXParserFactory in interface ISAXReaderSettings

Returns:

A custom SAX parser factory. This is only needed to work around some of the default SAXParserFactory configuration cannot be applied.

setCustomSAXParserFactory

@Nonnull
public final SAXReaderSettings setCustomSAXParserFactory(@Nullable
 SAXParserFactory aCustomSAXParserFactory)

isRequiresNewXMLParserExplicitly

public boolean isRequiresNewXMLParserExplicitly()

Specified by:

isRequiresNewXMLParserExplicitly in interface ISAXReaderSettings

Returns:

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

setRequiresNewXMLParserExplicitly

@Nonnull
public final SAXReaderSettings setRequiresNewXMLParserExplicitly(boolean bRequiresNewXMLParserExplicitly)

getClone

@Nonnull
public SAXReaderSettings getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<SAXReaderSettings>

applyToSAXReader

public void applyToSAXReader(@Nonnull
 XMLReader aParser)

Description copied from interface: ISAXReaderSettings

Apply all settings of this object onto the specified XMLReader object

Specified by:

applyToSAXReader in interface ISAXReaderSettings

Parameters:

aParser - The XML reader to apply the settings onto. May not be null.

toString

public String toString()

Overrides:

toString in class Object

createCloneOnDemand

@Nonnull
public static SAXReaderSettings createCloneOnDemand(@Nullable
 ISAXReaderSettings aOther)

Create a clone of the passed settings, depending on the parameter. If the parameter is null a new empty SAXReaderSettings object is created, otherwise a copy of the parameter is created.

Parameters:

aOther - The parameter to be used. May be null.

Returns:

Never null.