Home » xml-commons-external-1.4.01-src » javax » xml » parsers » [javadoc | source]
javax.xml.parsers
abstract public class: DocumentBuilderFactory [javadoc | source]
java.lang.Object
   javax.xml.parsers.DocumentBuilderFactory
Defines a factory API that enables applications to obtain a parser that produces DOM object trees from XML documents.
Constructor:
 protected DocumentBuilderFactory() 
Method from javax.xml.parsers.DocumentBuilderFactory Summary:
getAttribute,   getFeature,   getSchema,   isCoalescing,   isExpandEntityReferences,   isIgnoringComments,   isIgnoringElementContentWhitespace,   isNamespaceAware,   isValidating,   isXIncludeAware,   newDocumentBuilder,   newInstance,   newInstance,   setAttribute,   setCoalescing,   setExpandEntityReferences,   setFeature,   setIgnoringComments,   setIgnoringElementContentWhitespace,   setNamespaceAware,   setSchema,   setValidating,   setXIncludeAware
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.parsers.DocumentBuilderFactory Detail:
 abstract public Object getAttribute(String name) throws IllegalArgumentException
    Allows the user to retrieve specific attributes on the underlying implementation.
 abstract public 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 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.

 public Schema getSchema() 
 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.
 public boolean isExpandEntityReferences() 
    Indicates whether or not the factory is configured to produce parsers which expand entity reference nodes.
 public boolean isIgnoringComments() 
    Indicates whether or not the factory is configured to produce parsers which ignores comments.
 public boolean isIgnoringElementContentWhitespace() 
    Indicates whether or not the factory is configured to produce parsers which ignore ignorable whitespace in element content.
 public boolean isNamespaceAware() 
    Indicates whether or not the factory is configured to produce parsers which are namespace aware.
 public boolean isValidating() 
    Indicates whether or not the factory is configured to produce parsers which validate the XML content during parse.
 public boolean isXIncludeAware() 

    Get state of XInclude processing.

 abstract public DocumentBuilder newDocumentBuilder() throws ParserConfigurationException
 public static DocumentBuilderFactory newInstance() 
    Obtain a new instance of a DocumentBuilderFactory. This static method creates a new factory instance. This method uses the following ordered lookup procedure to determine the DocumentBuilderFactory implementation class to load:
    • 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. The jaxp.properties file is read only once by the JAXP implementation and it's 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 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.
    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 ....
    
 public static DocumentBuilderFactory newInstance(String factoryClassName,
    ClassLoader classLoader) 
 abstract public  void setAttribute(String name,
    Object value) throws IllegalArgumentException
    Allows the user to set specific attributes on the underlying implementation.
 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
 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
 abstract public  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.URI s. 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.

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

 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 .

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

 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. See here for more details.)

    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.

 public  void setXIncludeAware(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.