org.jahia.utils.xml

Class JahiaDocumentBuilderFactory

java.lang.Object

org.jahia.utils.xml.JahiaDocumentBuilderFactory

public class JahiaDocumentBuilderFactory
extends Object

A utility class that provides instances of DocumentBuilder XML parser.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
JahiaDocumentBuilderFactory()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Boolean>	getFeatures() Returns a map of XML parser features.
protected boolean	isNamespaceAware() Indicates whether or not the factory is configured to produce parsers which are namespace aware.
protected boolean	isValidating() Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
protected boolean	isXIncludeAware() Get state of XInclude processing.
static DocumentBuilderFactory	newInstance() Creates a new instance of a DocumentBuilderFactory using the currently configured parameters.
void	setExpandEntityReferences(boolean expandEntityRef) Specifies that the parser produced by this code will expand entity reference nodes.
void	setFeatures(Map<String,Boolean> features) Sets the features for this parser factory.
void	setNamespaceAware(boolean namespaceAware) Specifies that the parser produced by this code will provide support for XML namespaces.
void	setValidating(boolean validating) Specifies that the parser produced by this code will validate documents as they are parsed.
void	setXIncludeAware(boolean isXIncludeAware) Set state of XInclude processing.

Methods inherited from class java.lang.Object

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

Constructor Detail

JahiaDocumentBuilderFactory

public JahiaDocumentBuilderFactory()

Method Detail

newInstance

public static DocumentBuilderFactory newInstance()
                                          throws ParserConfigurationException

Creates a new instance of a DocumentBuilderFactory using the currently configured parameters.

Returns:

a new instance of a DocumentBuilderFactory

Throws:

ParserConfigurationException - if a DocumentBuilderFactory cannot be created which satisfies the configuration requested.

setExpandEntityReferences

public void setExpandEntityReferences(boolean expandEntityRef)

Specifies that the parser produced by this code will expand entity reference nodes. By default the value of this is set to false.

Parameters:

expandEntityRef - true if the parser produced will expand entity reference nodes; false otherwise.

getFeatures

protected Map<String,Boolean> getFeatures()

Returns a map of XML parser features.

Returns:

a map of XML parser features

isNamespaceAware

protected boolean isNamespaceAware()

Indicates whether or not the factory is configured to produce parsers which are namespace aware.

Returns:

true if the factory is configured to produce parsers which are namespace aware; false otherwise.

isValidating

protected boolean isValidating()

Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.

Returns:

true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

isXIncludeAware

protected boolean isXIncludeAware()

Get state of XInclude processing.

Returns:

current state of XInclude processing

Throws:

UnsupportedOperationException - When implementation does not override this method.

setFeatures

public void setFeatures(Map<String,Boolean> features)

Sets the features for this parser factory.

Parameters:

features - the map of features

setNamespaceAware

public void setNamespaceAware(boolean namespaceAware)

Specifies that the parser produced by this code will provide support for XML namespaces. By default the value of this is set to false

Parameters:

awareness - true if the parser produced will provide support for XML namespaces; false otherwise.

setValidating

public void setValidating(boolean validating)

Specifies that the parser produced by this code will validate documents as they are parsed. By default the value of this is set to false.

Parameters:

validating - true if the parser produced will validate documents as they are parsed; false otherwise.

setXIncludeAware

public void setXIncludeAware(boolean isXIncludeAware)

Set state of XInclude processing.

If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.

XInclude processing defaults to false.

Parameters:

state - Set XInclude processing to true or false