com.helger.commons.xml.serialize.read

Interface IBaseXMLReaderSettings

All Known Subinterfaces:

IDOMReaderSettings, ISAXReaderSettings

All Known Implementing Classes:

DOMReaderSettings, SAXReaderSettings

public interface IBaseXMLReaderSettings

Base Read-only interface for DOM and SAX reader settings.

Author:

Philip Helger

Method Summary

Modifier and Type	Method and Description
Map<EXMLParserFeature,Boolean>	getAllFeatureValues()
Map<EXMLParserProperty,Object>	getAllPropertyValues()
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
boolean	hasAnyFeature()
boolean	hasAnyProperties()
boolean	requiresNewXMLParser() Check if the current settings require a separate DOM DocumentBuilderFactory/SAX XMLReader object or if a pooled default object can be used.

Method Detail

hasAnyProperties

boolean hasAnyProperties()

Returns:

true if at least one parser property is defined

getPropertyValue

@Nullable
Object getPropertyValue(@Nullable
                                   EXMLParserProperty eProperty)

Get the value of the specified parser property

Parameters:

eProperty - The property to use. May be null.

Returns:

null if no such property was found.

getAllPropertyValues

@Nonnull
 @ReturnsMutableCopy
Map<EXMLParserProperty,Object> getAllPropertyValues()

Returns:

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

getLocale

@Nullable
Locale getLocale()

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.

hasAnyFeature

boolean hasAnyFeature()

Returns:

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

getFeatureValue

@Nullable
Boolean getFeatureValue(@Nullable
                                   EXMLParserFeature eFeature)

Get the value of the specified parser feature

Parameters:

eFeature - The feature to search. May be null.

Returns:

null if this feature is undefined.

getAllFeatureValues

@Nonnull
 @ReturnsMutableCopy
Map<EXMLParserFeature,Boolean> getAllFeatureValues()

Returns:

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

getErrorHandler

@Nullable
ErrorHandler getErrorHandler()

Returns:

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

getEntityResolver

@Nullable
EntityResolver getEntityResolver()

Returns:

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

getExceptionHandler

@Nonnull
IExceptionCallback<Throwable> getExceptionHandler()

Returns:

A special exception handler to be used. Never null.

requiresNewXMLParser

boolean requiresNewXMLParser()

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

Returns:

true if a separate parser object is required, false if not.