com.helger.commons.xml.serialize.read

Interface IDOMReaderSettings

All Superinterfaces:

IBaseXMLReaderSettings

All Known Implementing Classes:

DOMReaderSettings

public interface IDOMReaderSettings
extends IBaseXMLReaderSettings

Read-only interface for DOM reader settings.

Author:

Philip Helger

Method Summary

Methods

Modifier and Type	Method and Description
void	applyToDocumentBuilder(DocumentBuilder aDB) Apply settings of this object onto the specified DocumentBuilder object.
void	applyToDocumentBuilderFactory(DocumentBuilderFactory aDBF) Apply settings of this object onto the specified DocumentBuilderFactory object.
Schema	getSchema()
boolean	isCoalescing()
boolean	isExpandEntityReferences()
boolean	isIgnoringComments()
boolean	isIgnoringElementContentWhitespace()
boolean	isNamespaceAware()
boolean	isRequiresNewXMLParserExplicitly()
boolean	isValidating()
boolean	isXIncludeAware()
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

isNamespaceAware

boolean isNamespaceAware()

Returns:

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

isValidating

boolean isValidating()

Returns:

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

isIgnoringElementContentWhitespace

boolean isIgnoringElementContentWhitespace()

Returns:

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

isExpandEntityReferences

boolean isExpandEntityReferences()

Returns:

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

isIgnoringComments

boolean isIgnoringComments()

Returns:

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

isCoalescing

boolean isCoalescing()

Returns:

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

getSchema

@Nullable
Schema getSchema()

Returns:

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

isXIncludeAware

boolean isXIncludeAware()

Returns:

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

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.

applyToDocumentBuilderFactory

void applyToDocumentBuilderFactory(@Nonnull
                                 DocumentBuilderFactory aDBF)

Apply settings of this object onto the specified DocumentBuilderFactory object.

Parameters:

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

applyToDocumentBuilder

void applyToDocumentBuilder(@Nonnull
                          DocumentBuilder aDB)

Apply settings of this object onto the specified DocumentBuilder object.

Parameters:

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