< prev index next >

src/java.xml/share/classes/javax/xml/parsers/DocumentBuilderFactory.java

Print this page

        

*** 45,56 **** private boolean expandEntityRef = true; private boolean ignoreComments = false; private boolean coalescing = false; /** ! * <p>Protected constructor to prevent instantiation. ! * Use {@link #newInstance()}.</p> */ protected DocumentBuilderFactory () { } /** --- 45,56 ---- private boolean expandEntityRef = true; private boolean ignoreComments = false; private boolean coalescing = false; /** ! * Protected constructor to prevent instantiation. ! * Use {@link #newInstance()}. */ protected DocumentBuilderFactory () { } /**
*** 58,68 **** * {@code DocumentBuilderFactory}. This static method creates * a new factory instance. * This method uses the following ordered lookup procedure to determine * the {@code DocumentBuilderFactory} implementation class to * load: - * <p> * <ul> * <li> * Use the {@code javax.xml.parsers.DocumentBuilderFactory} system * property. * </li> --- 58,67 ----
*** 129,139 **** /* The fallback implementation class name */ "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl"); } /** ! * <p>Obtain a new instance of a {@code 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. * * <p>Once an application has obtained a reference to a {@code DocumentBuilderFactory} --- 128,138 ---- /* The fallback implementation class name */ "com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl"); } /** ! * Obtain a new instance of a {@code 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. * * <p>Once an application has obtained a reference to a {@code DocumentBuilderFactory}
*** 141,165 **** * * * <h2>Tip for Trouble-shooting</h2> * <p>Setting the {@code jaxp.debug} system property will cause * this method to print a lot of debug messages ! * to {@code System.err} about what it is doing and where it is looking at.</p> * ! * <p> If you have problems try:</p> * <pre> * java -Djaxp.debug=1 YourProgram .... * </pre> * ! * @param factoryClassName fully qualified factory class name that provides implementation of {@code javax.xml.parsers.DocumentBuilderFactory}. * ! * @param classLoader <code>ClassLoader</code> used to load the factory class. If <code>null</code> ! * current <code>Thread</code>'s context classLoader is used to load the factory class. * * @return New instance of a {@code DocumentBuilderFactory} * ! * @throws FactoryConfigurationError if <code>factoryClassName</code> is <code>null</code>, or * the factory class cannot be loaded, instantiated. * * @see #newInstance() * * @since 1.6 --- 140,165 ---- * * * <h2>Tip for Trouble-shooting</h2> * <p>Setting the {@code jaxp.debug} system property will cause * this method to print a lot of debug messages ! * to {@code System.err} about what it is doing and where it is looking at. * ! * <p> If you have problems try: * <pre> * java -Djaxp.debug=1 YourProgram .... * </pre> * ! * @param factoryClassName fully qualified factory class name that provides ! * implementation of {@code javax.xml.parsers.DocumentBuilderFactory}. * ! * @param classLoader {@code ClassLoader} used to load the factory class. If {@code null} ! * current {@code Thread}'s context classLoader is used to load the factory class. * * @return New instance of a {@code DocumentBuilderFactory} * ! * @throws FactoryConfigurationError if {@code factoryClassName} is {@code null}, or * the factory class cannot be loaded, instantiated. * * @see #newInstance() * * @since 1.6
*** 185,195 **** /** * Specifies that the parser produced by this code will * provide support for XML namespaces. By default the value of this is set ! * to <code>false</code> * * @param awareness true if the parser produced will provide support * for XML namespaces; false otherwise. */ --- 185,195 ---- /** * Specifies that the parser produced by this code will * provide support for XML namespaces. By default the value of this is set ! * to {@code false} * * @param awareness true if the parser produced will provide support * for XML namespaces; false otherwise. */
*** 198,224 **** } /** * Specifies that the parser produced by this code will * validate documents as they are parsed. By default the value of this ! * is set to <code>false</code>. * * <p> * Note that "the validation" here means * <a href="http://www.w3.org/TR/REC-xml#proc-types">a validating * parser</a> 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.) - * </p> * * <p> * 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 {@link #setValidating(boolean)} ! * method <code>false</code>, then use the {@link #setSchema(Schema)} * method to associate a schema to a parser. - * </p> * * @param validating true if the parser produced will validate documents * as they are parsed; false otherwise. */ --- 198,222 ---- } /** * Specifies that the parser produced by this code will * validate documents as they are parsed. By default the value of this ! * is set to {@code false}. * * <p> * Note that "the validation" here means * <a href="http://www.w3.org/TR/REC-xml#proc-types">a validating * parser</a> 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.) * * <p> * 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 {@link #setValidating(boolean)} ! * method {@code false}, then use the {@link #setSchema(Schema)} * method to associate a schema to a parser. * * @param validating true if the parser produced will validate documents * as they are parsed; false otherwise. */
*** 232,242 **** * '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 <code>false</code>. * * @param whitespace true if the parser created must eliminate whitespace * in the element content when parsing XML documents; * false otherwise. */ --- 230,240 ---- * '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 {@code false}. * * @param whitespace true if the parser created must eliminate whitespace * in the element content when parsing XML documents; * false otherwise. */
*** 246,282 **** } /** * Specifies that the parser produced by this code will * expand entity reference nodes. By default the value of this is set to ! * <code>true</code> * * @param expandEntityRef true if the parser produced will expand entity * reference nodes; false otherwise. */ public void setExpandEntityReferences(boolean expandEntityRef) { this.expandEntityRef = expandEntityRef; } /** ! * <p>Specifies that the parser produced by this code will ! * ignore comments. By default the value of this is set to <code>false ! * </code>.</p> * ! * @param ignoreComments <code>boolean</code> value to ignore comments during processing */ public void setIgnoringComments(boolean ignoreComments) { this.ignoreComments = ignoreComments; } /** * 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 ! * <code>false</code> * * @param 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. */ --- 244,279 ---- } /** * Specifies that the parser produced by this code will * expand entity reference nodes. By default the value of this is set to ! * {@code true} * * @param expandEntityRef true if the parser produced will expand entity * reference nodes; false otherwise. */ public void setExpandEntityReferences(boolean expandEntityRef) { this.expandEntityRef = expandEntityRef; } /** ! * Specifies that the parser produced by this code will ! * ignore comments. By default the value of this is set to {@code false}. * ! * @param ignoreComments {@code boolean} value to ignore comments during processing */ public void setIgnoringComments(boolean ignoreComments) { this.ignoreComments = ignoreComments; } /** * 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 ! * {@code false} * * @param 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. */
*** 365,393 **** * implementation. * <p> * All implementations that implement JAXP 1.5 or newer are required to * support the {@link javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD} and * {@link javax.xml.XMLConstants#ACCESS_EXTERNAL_SCHEMA} properties. ! * </p> * <ul> * <li> - * <p> * Setting the {@link 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, * {@link org.xml.sax.SAXException} will be thrown by the parse methods defined by * {@link javax.xml.parsers.DocumentBuilder}. ! * </p> ! * <p> * Setting the {@link 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, {@link org.xml.sax.SAXException} * will be thrown by the parse methods defined by * {@link javax.xml.parsers.DocumentBuilder}. - * </p> * </li> * </ul> * * @param name The name of the attribute. * @param value The value of the attribute. --- 362,388 ---- * implementation. * <p> * All implementations that implement JAXP 1.5 or newer are required to * support the {@link javax.xml.XMLConstants#ACCESS_EXTERNAL_DTD} and * {@link javax.xml.XMLConstants#ACCESS_EXTERNAL_SCHEMA} properties. ! * * <ul> * <li> * Setting the {@link 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, * {@link org.xml.sax.SAXException} will be thrown by the parse methods defined by * {@link javax.xml.parsers.DocumentBuilder}. ! * </li> ! * <li> * Setting the {@link 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, {@link org.xml.sax.SAXException} * will be thrown by the parse methods defined by * {@link javax.xml.parsers.DocumentBuilder}. * </li> * </ul> * * @param name The name of the attribute. * @param value The value of the attribute.
*** 411,475 **** */ public abstract Object getAttribute(String name) throws IllegalArgumentException; /** ! * <p>Set a feature for this {@code DocumentBuilderFactory} and <code>DocumentBuilder</code>s created by this factory.</p> * * <p> * Feature names are fully qualified {@link java.net.URI}s. * Implementations may define their own features. * A {@link ParserConfigurationException} is thrown if this {@code DocumentBuilderFactory} or the ! * <code>DocumentBuilder</code>s it creates cannot support the feature. * It is possible for a {@code DocumentBuilderFactory} to expose a feature value but be unable to change its state. ! * </p> * * <p> * All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. ! * When the feature is:</p> * <ul> * <li> ! * <code>true</code>: 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 * {@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}. * See {@link DocumentBuilder#setErrorHandler(org.xml.sax.ErrorHandler errorHandler)}. * </li> * <li> ! * <code>false</code>: the implementation will processing XML according to the XML specifications without * regard to possible implementation limits. * </li> * </ul> * * @param name Feature name. ! * @param value Is feature state <code>true</code> or <code>false</code>. * ! * @throws ParserConfigurationException if this {@code DocumentBuilderFactory} or the <code>DocumentBuilder</code>s * it creates cannot support this feature. ! * @throws NullPointerException If the <code>name</code> parameter is null. * @since 1.5 */ public abstract void setFeature(String name, boolean value) throws ParserConfigurationException; /** ! * <p>Get the state of the named feature.</p> * * <p> * Feature names are fully qualified {@link java.net.URI}s. * Implementations may define their own features. * An {@link ParserConfigurationException} is thrown if this {@code DocumentBuilderFactory} or the ! * <code>DocumentBuilder</code>s it creates cannot support the feature. * It is possible for an {@code DocumentBuilderFactory} to expose a feature value but be unable to change its state. ! * </p> * * @param name Feature name. * * @return State of the named feature. * * @throws ParserConfigurationException if this {@code DocumentBuilderFactory} ! * or the <code>DocumentBuilder</code>s it creates cannot support this feature. * @since 1.5 */ public abstract boolean getFeature(String name) throws ParserConfigurationException; --- 406,471 ---- */ public abstract Object getAttribute(String name) throws IllegalArgumentException; /** ! * Set a feature for this {@code DocumentBuilderFactory} ! * and {@code DocumentBuilder}s created by this factory. * * <p> * Feature names are fully qualified {@link java.net.URI}s. * Implementations may define their own features. * A {@link ParserConfigurationException} is thrown if this {@code DocumentBuilderFactory} or the ! * {@code DocumentBuilder}s it creates cannot support the feature. * It is possible for a {@code DocumentBuilderFactory} to expose a feature value but be unable to change its state. ! * * * <p> * All implementations are required to support the {@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} feature. ! * When the feature is: * <ul> * <li> ! * {@code 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 * {@link org.xml.sax.ErrorHandler#fatalError(SAXParseException exception)}. * See {@link DocumentBuilder#setErrorHandler(org.xml.sax.ErrorHandler errorHandler)}. * </li> * <li> ! * {@code false}: the implementation will processing XML according to the XML specifications without * regard to possible implementation limits. * </li> * </ul> * * @param name Feature name. ! * @param value Is feature state {@code true} or {@code false}. * ! * @throws ParserConfigurationException if this {@code DocumentBuilderFactory} or the {@code DocumentBuilder}s * it creates cannot support this feature. ! * @throws NullPointerException If the {@code name} parameter is null. * @since 1.5 */ public abstract void setFeature(String name, boolean value) throws ParserConfigurationException; /** ! * Get the state of the named feature. * * <p> * Feature names are fully qualified {@link java.net.URI}s. * Implementations may define their own features. * An {@link ParserConfigurationException} is thrown if this {@code DocumentBuilderFactory} or the ! * {@code DocumentBuilder}s it creates cannot support the feature. * It is possible for an {@code DocumentBuilderFactory} to expose a feature value but be unable to change its state. ! * * * @param name Feature name. * * @return State of the named feature. * * @throws ParserConfigurationException if this {@code DocumentBuilderFactory} ! * or the {@code DocumentBuilder}s it creates cannot support this feature. * @since 1.5 */ public abstract boolean getFeature(String name) throws ParserConfigurationException;
*** 499,509 **** ); } /** ! * <p>Set the {@link Schema} to be used by parsers created * from this factory. * * <p> * When a {@link Schema} is non-null, a parser will use a validator * created from it to validate documents before it passes information --- 495,505 ---- ); } /** ! * Set the {@link Schema} to be used by parsers created * from this factory. * * <p> * When a {@link Schema} is non-null, a parser will use a validator * created from it to validate documents before it passes information
*** 527,556 **** * <p> * Initially, null is set as the {@link Schema}. * * <p> * This processing will take effect even if ! * the {@link #isValidating()} method returns <code>false</code>. * * <p>It is an error to use ! * the <code>http://java.sun.com/xml/jaxp/properties/schemaSource</code> ! * property and/or the <code>http://java.sun.com/xml/jaxp/properties/schemaLanguage</code> * property in conjunction with a {@link Schema} object. * Such configuration will cause a {@link ParserConfigurationException} ! * exception when the {@link #newDocumentBuilder()} is invoked.</p> * * ! * <h4>Note for implementors</h4> * * <p> * A parser must be able to work with any {@link 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. - * </p> * ! * @param schema <code>Schema</code> to use or <code>null</code> * to remove a schema. * * @throws UnsupportedOperationException When implementation does not * override this method. * --- 523,552 ---- * <p> * Initially, null is set as the {@link Schema}. * * <p> * This processing will take effect even if ! * the {@link #isValidating()} method returns {@code false}. * * <p>It is an error to use ! * the {@code http://java.sun.com/xml/jaxp/properties/schemaSource} ! * property and/or the {@code http://java.sun.com/xml/jaxp/properties/schemaLanguage} * property in conjunction with a {@link Schema} object. * Such configuration will cause a {@link ParserConfigurationException} ! * exception when the {@link #newDocumentBuilder()} is invoked. * * ! * <h3>Note for implementors</h3> * * <p> * A parser must be able to work with any {@link 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. * ! * ! * @param schema {@code Schema} to use or {@code null} * to remove a schema. * * @throws UnsupportedOperationException When implementation does not * override this method. *
*** 567,586 **** } /** ! * <p>Set state of XInclude processing.</p> * * <p>If XInclude markup is found in the document instance, should it be * processed as specified in <a href="http://www.w3.org/TR/xinclude/"> ! * XML Inclusions (XInclude) Version 1.0</a>.</p> * ! * <p>XInclude processing defaults to <code>false</code>.</p> * ! * @param state Set XInclude processing to <code>true</code> or ! * <code>false</code> * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5 --- 563,582 ---- } /** ! * Set state of XInclude processing. * * <p>If XInclude markup is found in the document instance, should it be * processed as specified in <a href="http://www.w3.org/TR/xinclude/"> ! * XML Inclusions (XInclude) Version 1.0</a>. * ! * <p>XInclude processing defaults to {@code false}. * ! * @param state Set XInclude processing to {@code true} or ! * {@code false} * * @throws UnsupportedOperationException When implementation does not * override this method. * * @since 1.5
*** 592,602 **** " implementation or earlier: " + this.getClass()); } } /** ! * <p>Get state of XInclude processing.</p> * * @return current state of XInclude processing * * @throws UnsupportedOperationException When implementation does not * override this method. --- 588,598 ---- " implementation or earlier: " + this.getClass()); } } /** ! * Get state of XInclude processing. * * @return current state of XInclude processing * * @throws UnsupportedOperationException When implementation does not * override this method.
< prev index next >