com.helger.commons.xml.serialize.read

Interface ISAXReaderSettings

All Superinterfaces:

IBaseXMLReaderSettings

All Known Implementing Classes:

SAXReaderSettings

public interface ISAXReaderSettings
extends IBaseXMLReaderSettings

Read-only interface for the SAXReaderSettings. Implementations of this interface are meant to define settings that can be used with org.xml.sax.XMLReader instances.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
void	applyToSAXReader(XMLReader aParser) Apply all settings of this object onto the specified XMLReader object
ContentHandler	getContentHandler()
DeclHandler	getDeclarationHandler()
DTDHandler	getDTDHandler()
LexicalHandler	getLexicalHandler()
boolean	isRequiresNewXMLParserExplicitly()
boolean	requiresNewXMLParser() Check if the current settings require a separate DocumentBuilderFactory or if a pooled default object can be used.

Methods inherited from interface com.helger.commons.xml.serialize.read.IBaseXMLReaderSettings

getAllFeatureValues, getAllPropertyValues, getEntityResolver, getErrorHandler, getExceptionHandler, getFeatureValue, getLocale, getPropertyValue, hasAnyFeature, hasAnyProperties

Method Detail

getDTDHandler

@Nullable
DTDHandler getDTDHandler()

Returns:

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

getContentHandler

@Nullable
ContentHandler getContentHandler()

Returns:

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

getLexicalHandler

@Nullable
LexicalHandler getLexicalHandler()

Returns:

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

getDeclarationHandler

@Nullable
DeclHandler getDeclarationHandler()

Returns:

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

isRequiresNewXMLParserExplicitly

boolean isRequiresNewXMLParserExplicitly()

Returns:

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

requiresNewXMLParser

boolean requiresNewXMLParser()

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

Specified by:

requiresNewXMLParser in interface IBaseXMLReaderSettings

Returns:

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

applyToSAXReader

void applyToSAXReader(@Nonnull
                    XMLReader aParser)

Apply all settings of this object onto the specified XMLReader object

Parameters:

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