OpenJDK 27 · javax.xml.parsers.DocumentBuilderFactory

Modifier and Type	Field and Description
private boolean	coalescing
private static final String	DEFAULT_IMPL
private boolean	expandEntityRef
private boolean	ignoreComments
private boolean	namespaceAware
private boolean	validating
private boolean	whitespace

Access	Constructor and Description
protected	DocumentBuilderFactory() Protected constructor to prevent instantiation.

Method Summary

Modifier and Type	Method and Description
public abstract Object	Returns: value The value of the attribute. getAttribute(String The name of the attribute. name) Allows the user to retrieve specific attributes on the underlying implementation.
public abstract boolean	Returns: State of the named feature. getFeature(String Feature name. name) Get the state of the named feature.
public Schema	Returns: the `Schema` object that was last set through the `setSchema(Schema)` method, or null if the method was not invoked since a `DocumentBuilderFactory` is created. getSchema() Gets the `Schema` object specified through the `setSchema(Schema schema)` method.
public boolean	Returns: true if the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node; false otherwise. isCoalescing() Indicates whether or not the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node.
public boolean	Returns: true if the factory is configured to produce parsers which expand entity reference nodes; false otherwise. isExpandEntityReferences() Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.
public boolean	Returns: true if the factory is configured to produce parsers which ignores comments; false otherwise. isIgnoringComments() Indicates whether or not the factory is configured to produce parsers which ignores comments.
public boolean	Returns: true if the factory is configured to produce parsers which ignore ignorable whitespace in element content; false otherwise. isIgnoringElementContentWhitespace() Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.
public boolean	Returns: true if the factory is configured to produce parsers which are namespace aware; false otherwise. isNamespaceAware() Indicates whether or not the factory is configured to produce parsers which are namespace aware.
public boolean	Returns: true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise. isValidating() Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
public boolean	Returns: current state of XInclude processing isXIncludeAware() Get state of XInclude processing.
private static DocumentBuilderFactory	makeNSAware(DocumentBuilderFactory dbf)
public static DocumentBuilderFactory	Returns: A new instance of the `DocumentBuilderFactory` builtin system-default implementation. newDefaultInstance() Creates a new instance of the `DocumentBuilderFactory` builtin system-default implementation.
public static DocumentBuilderFactory	Returns: a new instance of the `DocumentBuilderFactory` builtin system-default implementation. newDefaultNSInstance() Creates a new NamespaceAware instance of the `DocumentBuilderFactory` builtin system-default implementation.
public abstract DocumentBuilder	Returns: A new instance of a DocumentBuilder. newDocumentBuilder() Creates a new instance of a `javax.xml.parsers.DocumentBuilder` using the currently configured parameters.
public static DocumentBuilderFactory	Returns: New instance of a `DocumentBuilderFactory` newInstance() Obtains a new instance of a `DocumentBuilderFactory`.
public static DocumentBuilderFactory	Returns: New instance of a `DocumentBuilderFactory` newInstance(String fully qualified factory class name that provides implementation of `javax.xml.parsers.DocumentBuilderFactory`. factoryClassName, ClassLoader `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class. classLoader) Obtain a new instance of a `DocumentBuilderFactory` from class name.
public static DocumentBuilderFactory	Returns: a new instance of a `DocumentBuilderFactory` newNSInstance() Creates a new NamespaceAware instance of a `DocumentBuilderFactory`.
public static DocumentBuilderFactory	Returns: a new instance of a `DocumentBuilderFactory` newNSInstance(String a fully qualified factory class name that provides implementation of `javax.xml.parsers.DocumentBuilderFactory`. factoryClassName, ClassLoader the `ClassLoader` used to load the factory class. If it is `null`, the current `Thread`'s context classLoader is used to load the factory class. classLoader) Creates a new NamespaceAware instance of a `DocumentBuilderFactory` from the class name.
public abstract void	setAttribute(String The name of the attribute. name, Object The value of the attribute. value) Allows the user to set specific attributes on the underlying implementation.
public void	setCoalescing(boolean true if the parser produced will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node; false otherwise. coalescing) Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node.
public void	setExpandEntityReferences(boolean true if the parser produced will expand entity reference nodes; false otherwise. expandEntityRef) Specifies that the parser produced by this code will expand entity reference nodes.
public abstract void	setFeature(String Feature name. name, boolean Is feature state `true` or `false`. value) Set a feature for this `DocumentBuilderFactory` and `DocumentBuilder`s created by this factory.
public void	setIgnoringComments(boolean `boolean` value to ignore comments during processing ignoreComments) Specifies that the parser produced by this code will ignore comments.
public void	setIgnoringElementContentWhitespace(boolean true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise. whitespace) Specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as 'ignorable whitespace') when parsing XML documents (see XML Rec 2.10).
public void	setNamespaceAware(boolean true if the parser produced will provide support for XML namespaces; false otherwise. awareness) Specifies that the parser produced by this code will provide support for XML namespaces.
public void	setSchema(Schema `Schema` to use or `null` to remove a schema. schema) Set the `Schema` to be used by parsers created from this factory.
public void	setValidating(boolean true if the parser produced will validate documents as they are parsed; false otherwise. validating) Specifies that the parser produced by this code will validate documents as they are parsed.
public void	setXIncludeAware(final boolean Set XInclude processing to `true` or `false` state) Set state of XInclude processing.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

coalescing	back to summary
private boolean coalescing

DEFAULT_IMPL	back to summary
private static final String DEFAULT_IMPL

expandEntityRef	back to summary
private boolean expandEntityRef

ignoreComments	back to summary
private boolean ignoreComments

namespaceAware	back to summary
private boolean namespaceAware

validating	back to summary
private boolean validating

whitespace	back to summary
private boolean whitespace

DocumentBuilderFactory	back to summary
protected DocumentBuilderFactory() Protected constructor to prevent instantiation. Use `newInstance()`.

Method Detail

getAttribute	back to summary
public abstract Object getAttribute(String name) throws IllegalArgumentException Allows the user to retrieve specific attributes on the underlying implementation. Parameters name:String The name of the attribute. Returns:Object value The value of the attribute. Exceptions IllegalArgumentException: thrown if the underlying implementation doesn't recognize the attribute.

getAttribute

back to summary

public abstract Object getAttribute(String name) throws IllegalArgumentException

Allows the user to retrieve specific attributes on the underlying implementation.

Parameters

name:String: The name of the attribute.

Returns:Object

value The value of the attribute.

Exceptions

IllegalArgumentException:: thrown if the underlying implementation doesn't recognize the attribute.

getFeature back to summary

getFeature	back to summary
public abstract boolean getFeature(String name) throws ParserConfigurationException Get the state of the named feature. Feature names are fully qualified `java.net.URI`s. Implementations may define their own features. An `ParserConfigurationException` is thrown if this `DocumentBuilderFactory` or the `DocumentBuilder`s it creates cannot support the feature. It is possible for an `DocumentBuilderFactory` to expose a feature value but be unable to change its state. Parameters name:String Feature name. Returns:boolean State of the named feature. Exceptions ParserConfigurationException: if this `DocumentBuilderFactory` or the `DocumentBuilder`s it creates cannot support this feature. Since 1.5

public abstract boolean getFeature(String name) throws ParserConfigurationException

Get the state of the named feature.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. An ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support the feature. It is possible for an DocumentBuilderFactory to expose a feature value but be unable to change its state.

Parameters

name:String: Feature name.

Returns:boolean

State of the named feature.

Exceptions

ParserConfigurationException:: if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.

Since

1.5

getSchema back to summary

getSchema	back to summary
public Schema getSchema() Gets the `Schema` object specified through the `setSchema(Schema schema)` method. Returns:Schema the `Schema` object that was last set through the `setSchema(Schema)` method, or null if the method was not invoked since a `DocumentBuilderFactory` is created. Exceptions UnsupportedOperationException: When implementation does not override this method. Since 1.5

public Schema getSchema()

Gets the Schema object specified through the setSchema(Schema schema) method.

Returns:Schema

the Schema object that was last set through the setSchema(Schema) method, or null if the method was not invoked since a DocumentBuilderFactory is created.

Exceptions

UnsupportedOperationException:: When implementation does not override this method.

Since

1.5

isCoalescing	back to summary
public boolean isCoalescing() Indicates whether or not the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node. Returns:boolean true if the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node; false otherwise.

isCoalescing

back to summary

public boolean isCoalescing()

Indicates whether or not the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node.

Returns:boolean: true if the factory is configured to produce parsers which converts CDATA nodes to Text nodes and appends it to the adjacent (if any) Text node; false otherwise.

isExpandEntityReferences	back to summary
public boolean isExpandEntityReferences() Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes. Returns:boolean true if the factory is configured to produce parsers which expand entity reference nodes; false otherwise.

isExpandEntityReferences

back to summary

public boolean isExpandEntityReferences()

Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.

Returns:boolean: true if the factory is configured to produce parsers which expand entity reference nodes; false otherwise.

isIgnoringComments	back to summary
public boolean isIgnoringComments() Indicates whether or not the factory is configured to produce parsers which ignores comments. Returns:boolean true if the factory is configured to produce parsers which ignores comments; false otherwise.

isIgnoringComments

back to summary

public boolean isIgnoringComments()

Indicates whether or not the factory is configured to produce parsers which ignores comments.

Returns:boolean: true if the factory is configured to produce parsers which ignores comments; false otherwise.

isIgnoringElementContentWhitespace	back to summary
public boolean isIgnoringElementContentWhitespace() Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content. Returns:boolean true if the factory is configured to produce parsers which ignore ignorable whitespace in element content; false otherwise.

isIgnoringElementContentWhitespace

back to summary

public boolean isIgnoringElementContentWhitespace()

Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.

Returns:boolean: true if the factory is configured to produce parsers which ignore ignorable whitespace in element content; false otherwise.

isNamespaceAware	back to summary
public boolean isNamespaceAware() Indicates whether or not the factory is configured to produce parsers which are namespace aware. Returns:boolean true if the factory is configured to produce parsers which are namespace aware; false otherwise.

isNamespaceAware

back to summary

public boolean isNamespaceAware()

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

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

isValidating	back to summary
public boolean isValidating() Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse. Returns:boolean true if the factory is configured to produce parsers which validate the XML content during parse; false otherwise.

isValidating

back to summary

public boolean isValidating()

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

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

isXIncludeAware	back to summary
public boolean isXIncludeAware() Get state of XInclude processing. Returns:boolean current state of XInclude processing Exceptions UnsupportedOperationException: When implementation does not override this method. Since 1.5

isXIncludeAware

back to summary

public boolean isXIncludeAware()

Get state of XInclude processing.

Returns:boolean

current state of XInclude processing

Exceptions

UnsupportedOperationException:: When implementation does not override this method.

Since

1.5

makeNSAware	back to summary
private static DocumentBuilderFactory makeNSAware(DocumentBuilderFactory dbf)

newDefaultInstance back to summary

newDefaultInstance	back to summary
public static DocumentBuilderFactory newDefaultInstance() Creates a new instance of the `DocumentBuilderFactory` builtin system-default implementation. Returns:DocumentBuilderFactory A new instance of the `DocumentBuilderFactory` builtin system-default implementation. Since 9

public static DocumentBuilderFactory newDefaultInstance()

Creates a new instance of the DocumentBuilderFactory builtin system-default implementation.

Returns:DocumentBuilderFactory: A new instance of the DocumentBuilderFactory builtin system-default implementation.
Since: 9

newDefaultNSInstance back to summary

newDefaultNSInstance	back to summary
public static DocumentBuilderFactory newDefaultNSInstance() Creates a new NamespaceAware instance of the `DocumentBuilderFactory` builtin system-default implementation. Parsers produced by the factory instance provides support for XML namespaces by default. Implementation Specification In addition to creating a factory instance using the same process as `newDefaultInstance()`, this method must set NamespaceAware to true. Returns:DocumentBuilderFactory a new instance of the `DocumentBuilderFactory` builtin system-default implementation. Since 13

public static DocumentBuilderFactory newDefaultNSInstance()

Creates a new NamespaceAware instance of the DocumentBuilderFactory builtin system-default implementation. Parsers produced by the factory instance provides support for XML namespaces by default.

Implementation Specification

In addition to creating a factory instance using the same process as newDefaultInstance(), this method must set NamespaceAware to true.

Returns:DocumentBuilderFactory: a new instance of the DocumentBuilderFactory builtin system-default implementation.
Since: 13

newDocumentBuilder back to summary

newDocumentBuilder	back to summary
public abstract DocumentBuilder newDocumentBuilder() throws ParserConfigurationException Creates a new instance of a `javax.xml.parsers.DocumentBuilder` using the currently configured parameters. Returns:DocumentBuilder A new instance of a DocumentBuilder. Exceptions ParserConfigurationException: if a DocumentBuilder cannot be created which satisfies the configuration requested.

public abstract DocumentBuilder newDocumentBuilder() throws ParserConfigurationException

Creates a new instance of a javax.xml.parsers.DocumentBuilder using the currently configured parameters.

Returns:DocumentBuilder

A new instance of a DocumentBuilder.

Exceptions

ParserConfigurationException:: if a DocumentBuilder cannot be created which satisfies the configuration requested.

newInstance back to summary

newInstance	back to summary
public static DocumentBuilderFactory newInstance() Obtains a new instance of a `DocumentBuilderFactory`. This method uses the JAXP Lookup Mechanism to determine the `DocumentBuilderFactory` implementation class to load. Once an application has obtained a reference to a `DocumentBuilderFactory`, it can use the factory to configure and obtain parser instances. Tip for Trouble-shooting Setting the `jaxp.debug` system property will cause this method to print a lot of debug messages to `System.err` about what it is doing and where it is looking at. If you have problems loading `DocumentBuilder`s, try: java -Djaxp.debug=1 YourProgram .... Returns:DocumentBuilderFactory New instance of a `DocumentBuilderFactory` Exceptions FactoryConfigurationError: in case of service configuration error or if the implementation is not available or cannot be instantiated.

public static DocumentBuilderFactory newInstance()

Obtains a new instance of a DocumentBuilderFactory. This method uses the JAXP Lookup Mechanism to determine the DocumentBuilderFactory implementation class to load.

Once an application has obtained a reference to a DocumentBuilderFactory, it can use the factory to configure and obtain parser instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems loading DocumentBuilders, try:

java -Djaxp.debug=1 YourProgram ....

Returns:DocumentBuilderFactory

New instance of a DocumentBuilderFactory

Exceptions

FactoryConfigurationError:: in case of service configuration error or if the implementation is not available or cannot be instantiated.

newInstance back to summary

newInstance	back to summary
public static DocumentBuilderFactory newInstance(String factoryClassName, ClassLoader classLoader) Obtain a new instance of a `DocumentBuilderFactory` from class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded. Once an application has obtained a reference to a `DocumentBuilderFactory` it can use the factory to configure and obtain parser instances. Tip for Trouble-shooting Setting the `jaxp.debug` system property will cause this method to print a lot of debug messages to `System.err` about what it is doing and where it is looking at. If you have problems try: java -Djaxp.debug=1 YourProgram .... Parameters factoryClassName:String fully qualified factory class name that provides implementation of `javax.xml.parsers.DocumentBuilderFactory`. classLoader:ClassLoader `ClassLoader` used to load the factory class. If `null` current `Thread`'s context classLoader is used to load the factory class. Returns:DocumentBuilderFactory New instance of a `DocumentBuilderFactory` Exceptions FactoryConfigurationError: if `factoryClassName` is `null`, or the factory class cannot be loaded, instantiated. Since 1.6 See Also `newInstance()`

public static DocumentBuilderFactory newInstance(String factoryClassName, ClassLoader classLoader)

Obtain a new instance of a DocumentBuilderFactory from class name. This function is useful when there are multiple providers in the classpath. It gives more control to the application as it can specify which provider should be loaded.

Once an application has obtained a reference to a DocumentBuilderFactory it can use the factory to configure and obtain parser instances.

Tip for Trouble-shooting

Setting the jaxp.debug system property will cause this method to print a lot of debug messages to System.err about what it is doing and where it is looking at.

If you have problems try:

java -Djaxp.debug=1 YourProgram ....

Parameters

factoryClassName:String: fully qualified factory class name that provides implementation of javax.xml.parsers.DocumentBuilderFactory.
classLoader:ClassLoader: ClassLoader used to load the factory class. If null current Thread's context classLoader is used to load the factory class.

Returns:DocumentBuilderFactory

New instance of a DocumentBuilderFactory

Exceptions

FactoryConfigurationError:: if factoryClassName is null, or the factory class cannot be loaded, instantiated.

Since

1.6

See Also

newInstance()

newNSInstance back to summary

newNSInstance	back to summary
public static DocumentBuilderFactory newNSInstance() Creates a new NamespaceAware instance of a `DocumentBuilderFactory`. Parsers produced by the factory instance provides support for XML namespaces by default. Implementation Specification In addition to creating a factory instance using the same process as `newInstance()`, this method must set NamespaceAware to true. Returns:DocumentBuilderFactory a new instance of a `DocumentBuilderFactory` Exceptions FactoryConfigurationError: in case of service configuration error or if the implementation is not available or cannot be instantiated. Since 13

public static DocumentBuilderFactory newNSInstance()

Creates a new NamespaceAware instance of a DocumentBuilderFactory. Parsers produced by the factory instance provides support for XML namespaces by default.

Implementation Specification

In addition to creating a factory instance using the same process as newInstance(), this method must set NamespaceAware to true.

Returns:DocumentBuilderFactory

a new instance of a DocumentBuilderFactory

Exceptions

FactoryConfigurationError:: in case of service configuration error or if the implementation is not available or cannot be instantiated.

Since

newNSInstance back to summary

newNSInstance	back to summary
public static DocumentBuilderFactory newNSInstance(String factoryClassName, ClassLoader classLoader) Creates a new NamespaceAware instance of a `DocumentBuilderFactory` from the class name. Parsers produced by the factory instance provides support for XML namespaces by default. Implementation Specification In addition to creating a factory instance using the same process as `newInstance(java.lang.String, java.lang.ClassLoader)`, this method must set NamespaceAware to true. Parameters factoryClassName:String a fully qualified factory class name that provides implementation of `javax.xml.parsers.DocumentBuilderFactory`. classLoader:ClassLoader the `ClassLoader` used to load the factory class. If it is `null`, the current `Thread`'s context classLoader is used to load the factory class. Returns:DocumentBuilderFactory a new instance of a `DocumentBuilderFactory` Exceptions FactoryConfigurationError: if `factoryClassName` is `null`, or the factory class cannot be loaded, instantiated. Since 13

public static DocumentBuilderFactory newNSInstance(String factoryClassName, ClassLoader classLoader)

Creates a new NamespaceAware instance of a DocumentBuilderFactory from the class name. Parsers produced by the factory instance provides support for XML namespaces by default.

Implementation Specification

In addition to creating a factory instance using the same process as newInstance(java.lang.String, java.lang.ClassLoader), this method must set NamespaceAware to true.

Parameters

factoryClassName:String: a fully qualified factory class name that provides implementation of javax.xml.parsers.DocumentBuilderFactory.
classLoader:ClassLoader: the ClassLoader used to load the factory class. If it is null, the current Thread's context classLoader is used to load the factory class.

Returns:DocumentBuilderFactory

a new instance of a DocumentBuilderFactory

Exceptions

FactoryConfigurationError:: if factoryClassName is null, or the factory class cannot be loaded, instantiated.

Since

setAttribute back to summary

setAttribute	back to summary
public abstract void setAttribute(String name, Object value) throws IllegalArgumentException Allows the user to set specific attributes on the underlying implementation. All implementations that implement JAXP 1.5 or newer are required to support the `javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD` and `javax.xml.XMLConstants#ACCESS_EXTERNAL_SCHEMA` properties. Setting the `javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD` property restricts the access to external DTDs, external Entity References to the protocols specified by the property. If access is denied during parsing due to the restriction of this property, `org.xml.sax.SAXException` will be thrown by the parse methods defined by `javax.xml.parsers.DocumentBuilder`. Setting the `javax.xml.XMLConstants#ACCESS_EXTERNAL_SCHEMA` property restricts the access to external Schema set by the schemaLocation attribute to the protocols specified by the property. If access is denied during parsing due to the restriction of this property, `org.xml.sax.SAXException` will be thrown by the parse methods defined by `javax.xml.parsers.DocumentBuilder`. Parameters name:String The name of the attribute. value:Object The value of the attribute. Exceptions IllegalArgumentException: thrown if the underlying implementation doesn't recognize the attribute.

public abstract void setAttribute(String name, Object value) throws IllegalArgumentException

Allows the user to set specific attributes on the underlying implementation.

All implementations that implement JAXP 1.5 or newer are required to support the javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD and javax.xml.XMLConstants#ACCESS_EXTERNAL_SCHEMA properties.

Setting the javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD property restricts the access to external DTDs, external Entity References to the protocols specified by the property. If access is denied during parsing due to the restriction of this property, org.xml.sax.SAXException will be thrown by the parse methods defined by javax.xml.parsers.DocumentBuilder.
Setting the javax.xml.XMLConstants#ACCESS_EXTERNAL_SCHEMA property restricts the access to external Schema set by the schemaLocation attribute to the protocols specified by the property. If access is denied during parsing due to the restriction of this property, org.xml.sax.SAXException will be thrown by the parse methods defined by javax.xml.parsers.DocumentBuilder.

Parameters

name:String: The name of the attribute.
value:Object: The value of the attribute.

Exceptions

IllegalArgumentException:: thrown if the underlying implementation doesn't recognize the attribute.

setCoalescing back to summary

setCoalescing	back to summary
public void setCoalescing(boolean coalescing) Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node. By default the value of this is set to `false` Parameters coalescing:boolean true if the parser produced will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node; false otherwise.

public void setCoalescing(boolean coalescing)

Specifies that the parser produced by this code will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node. By default the value of this is set to false

Parameters

coalescing:boolean: true if the parser produced will convert CDATA nodes to Text nodes and append it to the adjacent (if any) text node; false otherwise.

setExpandEntityReferences back to summary

setExpandEntityReferences	back to summary
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 `true` Parameters expandEntityRef:boolean true if the parser produced will expand entity reference nodes; false otherwise.

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 true

Parameters

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

setFeature back to summary

setFeature	back to summary
public abstract void setFeature(String name, boolean value) throws ParserConfigurationException Set a feature for this `DocumentBuilderFactory` and `DocumentBuilder`s created by this factory. Feature names are fully qualified `java.net.URI`s. Implementations may define their own features. A `ParserConfigurationException` is thrown if this `DocumentBuilderFactory` or the `DocumentBuilder`s it creates cannot support the feature. It is possible for a `DocumentBuilderFactory` to expose a feature value but be unable to change its state. All implementations are required to support the `javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING` feature. When the feature is: `true`: the implementation will limit XML processing to conform to implementation limits. Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered `org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)`. See `DocumentBuilder#setErrorHandler(org.xml.sax.ErrorHandler errorHandler)`. `false`: the implementation will processing XML according to the XML specifications without regard to possible implementation limits. Parameters name:String Feature name. value:boolean Is feature state `true` or `false`. Exceptions ParserConfigurationException: if this `DocumentBuilderFactory` or the `DocumentBuilder`s it creates cannot support this feature. NullPointerException: If the `name` parameter is null. Since 1.5

public abstract void setFeature(String name, boolean value) throws ParserConfigurationException

Set a feature for this DocumentBuilderFactory and DocumentBuilders created by this factory.

Feature names are fully qualified java.net.URIs. Implementations may define their own features. A ParserConfigurationException is thrown if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support the feature. It is possible for a DocumentBuilderFactory to expose a feature value but be unable to change its state.

All implementations are required to support the javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING feature. When the feature is:

true: the implementation will limit XML processing to conform to implementation limits. Examples include entity expansion limits and XML Schema constructs that would consume large amounts of resources. If XML processing is limited for security reasons, it will be reported via a call to the registered org.xml.sax.ErrorHandler#fatalError(SAXParseException exception). See DocumentBuilder#setErrorHandler(org.xml.sax.ErrorHandler errorHandler).
false: the implementation will processing XML according to the XML specifications without regard to possible implementation limits.

Parameters

name:String: Feature name.
value:boolean: Is feature state true or false.

Exceptions

ParserConfigurationException:: if this DocumentBuilderFactory or the DocumentBuilders it creates cannot support this feature.
NullPointerException:: If the name parameter is null.

Since

1.5

setIgnoringComments back to summary

setIgnoringComments	back to summary
public void setIgnoringComments(boolean ignoreComments) Specifies that the parser produced by this code will ignore comments. By default the value of this is set to `false`. Parameters ignoreComments:boolean `boolean` value to ignore comments during processing

public void setIgnoringComments(boolean ignoreComments)

Specifies that the parser produced by this code will ignore comments. By default the value of this is set to false.

Parameters

ignoreComments:boolean: boolean value to ignore comments during processing

setIgnoringElementContentWhitespace back to summary

setIgnoringElementContentWhitespace	back to summary
public void setIgnoringElementContentWhitespace(boolean whitespace) Specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as 'ignorable whitespace') when parsing XML documents (see XML Rec 2.10). Note that only whitespace which is directly contained within element content that has an element only content model (see XML Rec 3.2.1) will be eliminated. Due to reliance on the content model this setting requires the parser to be in validating mode. By default the value of this is set to `false`. Parameters whitespace:boolean true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise.

public void setIgnoringElementContentWhitespace(boolean whitespace)

Specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as 'ignorable whitespace') when parsing XML documents (see XML Rec 2.10). Note that only whitespace which is directly contained within element content that has an element only content model (see XML Rec 3.2.1) will be eliminated. Due to reliance on the content model this setting requires the parser to be in validating mode. By default the value of this is set to false.

Parameters

whitespace:boolean: true if the parser created must eliminate whitespace in the element content when parsing XML documents; false otherwise.

setNamespaceAware back to summary

setNamespaceAware	back to summary
public void setNamespaceAware(boolean awareness) 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:boolean true if the parser produced will provide support for XML namespaces; false otherwise.

public void setNamespaceAware(boolean awareness)

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:boolean: true if the parser produced will provide support for XML namespaces; false otherwise.

setSchema back to summary

setSchema	back to summary
public void setSchema(Schema schema) Set the `Schema` to be used by parsers created from this factory. When a `Schema` is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application. When errors are found by the validator, the parser is responsible to report them to the user-specified `org.xml.sax.ErrorHandler` (or if the error handler is not set, ignore them or throw them), just like any other errors found by the parser itself. In other words, if the user-specified `org.xml.sax.ErrorHandler` is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules. A validator may modify the outcome of a parse (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive modified DOM trees. Initially, null is set as the `Schema`. This processing will take effect even if the `isValidating()` method returns `false`. It is an error to use the `http://java.sun.com/xml/jaxp/properties/schemaSource` property and/or the `http://java.sun.com/xml/jaxp/properties/schemaLanguage` property in conjunction with a `Schema` object. Such configuration will cause a `ParserConfigurationException` exception when the `newDocumentBuilder()` is invoked. Note for implementors A parser must be able to work with any `Schema` implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification. Parameters schema:Schema `Schema` to use or `null` to remove a schema. Exceptions UnsupportedOperationException: When implementation does not override this method. Since 1.5

public void setSchema(Schema schema)

Set the Schema to be used by parsers created from this factory.

When a Schema is non-null, a parser will use a validator created from it to validate documents before it passes information down to the application.

When errors are found by the validator, the parser is responsible to report them to the user-specified org.xml.sax.ErrorHandler (or if the error handler is not set, ignore them or throw them), just like any other errors found by the parser itself. In other words, if the user-specified org.xml.sax.ErrorHandler is set, it must receive those errors, and if not, they must be treated according to the implementation specific default error handling rules.

A validator may modify the outcome of a parse (for example by adding default values that were missing in documents), and a parser is responsible to make sure that the application will receive modified DOM trees.

Initially, null is set as the Schema.

This processing will take effect even if the isValidating() method returns false.

It is an error to use the http://java.sun.com/xml/jaxp/properties/schemaSource property and/or the http://java.sun.com/xml/jaxp/properties/schemaLanguage property in conjunction with a Schema object. Such configuration will cause a ParserConfigurationException exception when the newDocumentBuilder() is invoked.

Note for implementors

A parser must be able to work with any Schema implementation. However, parsers and schemas are allowed to use implementation-specific custom mechanisms as long as they yield the result described in the specification.

Parameters

schema:Schema: Schema to use or null to remove a schema.

Exceptions

UnsupportedOperationException:: When implementation does not override this method.

Since

1.5

setValidating back to summary

setValidating	back to summary
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`. Note that "the validation" here means a validating parser as defined in the XML recommendation. In other words, it essentially just controls the DTD validation. (except the legacy two properties defined in JAXP 1.2.) To use modern schema languages such as W3C XML Schema or RELAX NG instead of DTD, you can configure your parser to be a non-validating parser by leaving the `setValidating(boolean)` method `false`, then use the `setSchema(Schema)` method to associate a schema to a parser. Parameters validating:boolean true if the parser produced will validate documents as they are parsed; false otherwise.

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.

Note that "the validation" here means a validating parser as defined in the XML recommendation. In other words, it essentially just controls the DTD validation. (except the legacy two properties defined in JAXP 1.2.)

To use modern schema languages such as W3C XML Schema or RELAX NG instead of DTD, you can configure your parser to be a non-validating parser by leaving the setValidating(boolean) method false, then use the setSchema(Schema) method to associate a schema to a parser.

Parameters

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

setXIncludeAware back to summary

setXIncludeAware	back to summary
public void setXIncludeAware(final boolean state) 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:boolean Set XInclude processing to `true` or `false` Exceptions UnsupportedOperationException: When implementation does not override this method. Since 1.5

public void setXIncludeAware(final boolean state)

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:boolean: Set XInclude processing to true or false

Exceptions

UnsupportedOperationException:: When implementation does not override this method.

Since

1.5

public abstract Class DocumentBuilderFactory

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Tip for Trouble-shooting

Tip for Trouble-shooting

Note for implementors