Documentbuilderfactory java что это

Class DocumentBuilderFactory

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:

newInstance

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:

newDocumentBuilder

setNamespaceAware

setValidating

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.

setIgnoringElementContentWhitespace

setExpandEntityReferences

setIgnoringComments

setCoalescing

isNamespaceAware

isValidating

isIgnoringElementContentWhitespace

isExpandEntityReferences

isIgnoringComments

isCoalescing

setAttribute

• Setting the 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, SAXException will be thrown by the parse methods defined by DocumentBuilder .
• Setting the 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, SAXException will be thrown by the parse methods defined by DocumentBuilder .

getAttribute

setFeature

Feature names are fully qualified 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.

• 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 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.

getFeature

Feature names are fully qualified 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.

getSchema

setSchema

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 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 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.

setXIncludeAware

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 .

isXIncludeAware

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2022, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

Documentbuilderfactory java что это

Use the configuration file «jaxp.properties». The file is in standard Properties format and typically located in the conf directory of the Java installation. It contains the fully qualified name of the implementation class with the key being the system property defined above.

The jaxp.properties file is read only once by the JAXP implementation and its values are then cached for future use. If the file does not exist when the first attempt is made to read from it, no further attempts are made to check for its existence. It is not possible to change the value of any property in jaxp.properties after it has been read for the first time.

Use the service-provider loading facility, defined by the ServiceLoader class, to attempt to locate and load an implementation of the service using the default loading mechanism: the service-provider loading facility will use the current thread’s context class loader to attempt to load the service. If the context class loader is null, the system class loader will be used.

Otherwise, the system-default implementation is returned.

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:

newInstance

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:

newDocumentBuilder

setNamespaceAware

setValidating

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.

setIgnoringElementContentWhitespace

setExpandEntityReferences

setIgnoringComments

setCoalescing

isNamespaceAware

isValidating

isIgnoringElementContentWhitespace

isExpandEntityReferences

isIgnoringComments

isCoalescing

setAttribute

• Setting the 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, SAXException will be thrown by the parse methods defined by DocumentBuilder .
• Setting the 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, SAXException will be thrown by the parse methods defined by DocumentBuilder .

getAttribute

setFeature

Feature names are fully qualified 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.

• 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 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.

getFeature

Feature names are fully qualified 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.

getSchema

setSchema

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 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 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.

setXIncludeAware

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 .

isXIncludeAware

Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2022, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.

Javax.xml.Parsers.DocumentBuilderFactory Class

The javax.xml.Parsers.DocumentBuilderFactory class defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents.

Class declaration

Following is the declaration for javax.xml.Parsers.DocumentBuilderFactory class −

Class constructors

This is the protected constructor to prevent instantiation.

Class methods

This method allows the user to retrieve specific attributes on the underlying implementation.

This method gets the state of the named feature.

This method gets the Schema object specified through the setSchema(Schema schema) method.

This method 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.

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

This method indicates whether or not the factory is configured to produce parsers which ignores comments.

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

This method indicates whether or not the factory is configured to produce parsers which are namespace aware.

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

This method gets state of XInclude processing.

This method creates a new instance of a DocumentBuilder using the currently configured parameters.

This method obtains a new instance of a DocumentBuilderFactory

This method obtains a new instance of a DocumentBuilderFactory from class name.

This method allows the user to set specific attributes on the underlying implementation.

This method 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.

This method specifies that the parser produced by this code will expand entity reference nodes.

This method set a feature for this DocumentBuilderFactory and DocumentBuilders created by this factory.

This method specifies that the parser produced by this code will ignore comments.

This method specifies that the parsers created by this factory must eliminate whitespace in element content (sometimes known loosely as ‘ignorable whitespace’) when parsing XML documents.

This method specifies that the parser produced by this code will provide support for XML namespaces.

This method set the Schema to be used by parsers created from this factory.

This method specifies that the parser produced by this code will validate documents as they are parsed.

Documentbuilderfactory java что это

Defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents. An implementation of the DocumentBuilderFactory class is NOT guaranteed to be thread safe. It is up to the user application to make sure about the use of the DocumentBuilderFactory from more than one thread. Alternatively the application can have one instance of the DocumentBuilderFactory per thread. An application can use the same instance of the factory to obtain one or more instances of the DocumentBuilder provided the instance of the factory isn’t being used in more than one thread at a time.

Since: JAXP 1.0 Version: 1.0

DocumentBuilderFactory

newInstance

• Use the javax.xml.parsers.DocumentBuilderFactory system property.
• Use the properties file «lib/jaxp.properties» in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above.
• Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.parsers.DocumentBuilderFactory in jars available to the runtime.
• Platform default DocumentBuilderFactory instance.

Throws: FactoryConfigurationError — if the implementation is not available or cannot be instantiated.

newDocumentBuilder

Returns: A new instance of a DocumentBuilder. Throws: ParserConfigurationException — if a DocumentBuilder cannot be created which satisfies the configuration requested.

setNamespaceAware

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

setValidating

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

setIgnoringElementContentWhitespace

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

setExpandEntityReferences

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

setIgnoringComments

setCoalescing

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

isNamespaceAware

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

isValidating

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

isIgnoringElementContentWhitespace

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

isExpandEntityReferences

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

isIgnoringComments

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

isCoalescing

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.

setAttribute

Parameters: name — The name of the attribute. value — The value of the attribute. Throws: IllegalArgumentException — thrown if the underlying implementation doesn’t recognize the attribute.