286N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 286N/A * This code is free software; you can redistribute it and/or modify it 286N/A * under the terms of the GNU General Public License version 2 only, as 286N/A * published by the Free Software Foundation. Oracle designates this 286N/A * particular file as subject to the "Classpath" exception as provided 286N/A * by Oracle in the LICENSE file that accompanied this code. 286N/A * This code is distributed in the hope that it will be useful, but WITHOUT 286N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 286N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 286N/A * version 2 for more details (a copy is included in the LICENSE file that 286N/A * accompanied this code). 286N/A * You should have received a copy of the GNU General Public License version 286N/A * 2 along with this work; if not, write to the Free Software Foundation, 286N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 286N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 286N/A * or visit www.oracle.com if you need additional information or have any 286N/A * This file is available under and governed by the GNU General Public 286N/A * License version 2 only, as published by the Free Software Foundation. 286N/A * However, the following notice accompanied the original version of this 286N/A * file and, per its terms, should not be removed: 286N/A * Copyright (c) 2004 World Wide Web Consortium, 286N/A * (Massachusetts Institute of Technology, European Research Consortium for 286N/A * Informatics and Mathematics, Keio University). All Rights Reserved. This 286N/A * work is distributed under the W3C(r) Software License [1] in the hope that 286N/A * it will be useful, but WITHOUT ANY WARRANTY; without even the implied 286N/A * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 286N/A * The <code>DOMConfiguration</code> interface represents the configuration 286N/A * of a document and maintains a table of recognized parameters. Using the 286N/A * configuration, it is possible to change 286N/A * <code>Document.normalizeDocument()</code> behavior, such as replacing the 286N/A * <code>CDATASection</code> nodes with <code>Text</code> nodes or 286N/A * specifying the type of the schema that must be used when the validation 286N/A * of the <code>Document</code> is requested. <code>DOMConfiguration</code> 286N/A * in the <code>DOMParser</code> and <code>DOMSerializer</code> interfaces. 286N/A * <p> The parameter names used by the <code>DOMConfiguration</code> object 286N/A * are defined throughout the DOM Level 3 specifications. Names are 286N/A * case-insensitive. To avoid possible conflicts, as a convention, names 286N/A * referring to parameters defined outside the DOM specification should be 286N/A * made unique. Because parameters are exposed as properties in names 286N/A * are recommended to follow the section 5.16 Identifiers of [Unicode] with the addition of the character '-' (HYPHEN-MINUS) but it is not 286N/A * enforced by the DOM implementation. DOM Level 3 Core Implementations are 286N/A * required to recognize all parameters defined in this specification. Some 286N/A * parameter values may also be required to be supported by the 286N/A * implementation. Refer to the definition of the parameter to know if a 286N/A * value must be supported or not. 286N/A * <p ><b>Note:</b> Parameters are similar to features and properties used in 286N/A * <p> The following list of parameters defined in the DOM: 286N/A * <code>"canonical-form"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * such as removing the <code>DocumentType</code> node (if any) from the 286N/A * tree, or removing superfluous namespace declarations from each element. 286N/A * Note that this is limited to what can be represented in the DOM; in 286N/A * particular, there is no way to specify the order of the attributes in the 286N/A * DOM. In addition, Setting this parameter to <code>true</code> will also 286N/A * set the state of the parameters listed below. Later changes to the state 286N/A * of one of those parameters will revert "canonical-form" back to 286N/A * <code>false</code>. Parameters set to <code>false</code>: "entities", " 286N/A * normalize-characters", "cdata-sections". Parameters set to 286N/A * <code>true</code>: "namespaces", "namespace-declarations", "well-formed", 286N/A * "element-content-whitespace". Other parameters are not changed unless 286N/A * explicitly specified in the description of the parameters.</dd> 286N/A * <code>false</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Do not canonicalize the document.</dd> 286N/A * <dt><code>"cdata-sections"</code></dt> 286N/A * <code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Keep <code>CDATASection</code> nodes in the document.</dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>required</em>]Transform <code>CDATASection</code> nodes in the document into 286N/A * <code>Text</code> nodes. The new <code>Text</code> node is then combined 286N/A * with any adjacent <code>Text</code> node.</dd> 286N/A * <code>"check-character-normalization"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * sequence of characters is encountered that fails normalization checking, 286N/A * an error with the <code>DOMError.type</code> equals to 286N/A * "check-character-normalization-failure" is issued. </dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Do not check if characters are normalized.</dd> 286N/A * <dt><code>"comments"</code></dt> 286N/A * <code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Keep <code>Comment</code> nodes in the document.</dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>required</em>]Discard <code>Comment</code> nodes in the document.</dd> 286N/A * <code>"datatype-normalization"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * Schema normalized values</a> in the case of XML Schema. Since this parameter requires to have schema 286N/A * information, the "validate" parameter will also be set to 286N/A * <code>true</code>. Having this parameter activated when "validate" is 286N/A * <code>false</code> has no effect and no schema-normalization will happen. 286N/A * <p ><b>Note:</b> Since the document contains the result of the XML 1.0 286N/A * processing, this parameter does not apply to attribute value 286N/A * meant for schema languages other than Document Type Definition (DTD). </dd> 286N/A * <code>false</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>) Do not perform schema normalization on the tree. </dd> 286N/A * <code>"element-content-whitespace"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Keep all whitespaces in the document.</dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>optional</em>] Discard all <code>Text</code> nodes that contain whitespaces in element 286N/A * [element content whitespace]</a>. The implementation is expected to use the attribute 286N/A * <code>Text.isElementContentWhitespace</code> to determine if a 286N/A * <code>Text</code> node should be discarded or not.</dd> 286N/A * <dt><code>"entities"</code></dt> 286N/A * <code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Keep <code>EntityReference</code> nodes in the document.</dd> 286N/A * <code>false</code></dt> 286N/A * <dd>[<em>required</em>] Remove all <code>EntityReference</code> nodes from the document, 286N/A * putting the entity expansions directly in their place. <code>Text</code> 286N/A * unexpanded entity references</a> are kept in the document. </dd> 286N/A * <p ><b>Note:</b> This parameter does not affect <code>Entity</code> nodes. </dd> 286N/A * <code>"error-handler"</code></dt> 286N/A * <dd>[<em>required</em>] Contains a <code>DOMErrorHandler</code> object. If an error is 286N/A * encountered in the document, the implementation will call back the 286N/A * <code>DOMErrorHandler</code> registered using this parameter. The 286N/A * implementation may provide a default <code>DOMErrorHandler</code> object. 286N/A * When called, <code>DOMError.relatedData</code> will contain the closest 286N/A * node to where the error occurred. If the implementation is unable to 286N/A * determine the node where the error occurs, 286N/A * <code>DOMError.relatedData</code> will contain the <code>Document</code> 286N/A * node. Mutations to the document from within an error handler will result 286N/A * in implementation dependent behavior. </dd> 286N/A * <dt><code>"infoset"</code></dt> 286N/A * <code>true</code></dt> 286N/A * .This forces the following parameters to <code>false</code>: " 286N/A * validate-if-schema", "entities", "datatype-normalization", "cdata-sections 286N/A * ".This forces the following parameters to <code>true</code>: " 286N/A * namespace-declarations", "well-formed", "element-content-whitespace", " 286N/A * comments", "namespaces".Other parameters are not changed unless 286N/A * explicitly specified in the description of the parameters. Note that 286N/A * querying this parameter with <code>getParameter</code> returns 286N/A * <code>true</code> only if the individual parameters specified above are 286N/A * appropriately set.</dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>Setting <code>infoset</code> to 286N/A * <code>false</code> has no effect.</dd> 286N/A * <dt><code>"namespaces"</code></dt> 286N/A * <code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>) Perform the namespace processing as defined in . </dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>optional</em>] Do not perform the namespace processing. </dd> 286N/A * <code>"namespace-declarations"</code></dt> 286N/A * <dd> This parameter has no effect if the 286N/A * parameter "namespaces" is set to <code>false</code>. 286N/A * <dt><code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>) Include namespace declaration attributes, specified or defaulted from 286N/A * the schema, in the document. See also the sections "Declaring Namespaces" 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>required</em>]Discard all namespace declaration attributes. The namespace prefixes ( 286N/A * <code>Node.prefix</code>) are retained even if this parameter is set to 286N/A * <code>false</code>.</dd> 286N/A * <dt><code>"normalize-characters"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * <code>false</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Do not perform character normalization.</dd> 286N/A * <dt><code>"schema-location"</code></dt> 286N/A * <dd>[<em>optional</em>] Represent a <code>DOMString</code> object containing a list of URIs, 286N/A * represents the schemas against which validation should occur, i.e. the 286N/A * current schema. The types of schemas referenced in this list must match 286N/A * the type specified with <code>schema-type</code>, otherwise the behavior 286N/A * of an implementation is undefined. The schemas specified using this 286N/A * property take precedence to the schema information specified in the 286N/A * document itself. For namespace aware schema, if a schema specified using 286N/A * this property and a schema specified in the document instance (i.e. using 286N/A * the <code>schemaLocation</code> attribute) in a schema document (i.e. 286N/A * using schema <code>import</code> mechanisms) share the same 286N/A * <code>targetNamespace</code>, the schema specified by the user using this 286N/A * property will be used. If two schemas specified using this property share 286N/A * the same <code>targetNamespace</code> or have no namespace, the behavior 286N/A * is implementation dependent. If no location has been provided, this 286N/A * parameter is <code>null</code>. 286N/A * <p ><b>Note:</b> The <code>"schema-location"</code> parameter is ignored 286N/A * unless the "schema-type" parameter value is set. It is strongly 286N/A * recommended that <code>Document.documentURI</code> will be set so that an 286N/A * implementation can successfully resolve any external entities referenced. </dd> 286N/A * <code>"schema-type"</code></dt> 286N/A * <dd>[<em>optional</em>] Represent a <code>DOMString</code> object containing an absolute URI 286N/A * and representing the type of the schema language used to validate a 286N/A * document against. Note that no lexical checking is done on the absolute 286N/A * URI. If this parameter is not set, a default value may be provided by 286N/A * the implementation, based on the schema languages supported and on the 286N/A * schema language used at load time. If no value is provided, this 286N/A * parameter is <code>null</code>. 286N/A * , applications must use the value 286N/A * applications must use the value 286N/A * outside the scope of the W3C and therefore should recommend an absolute 286N/A * URI in order to use this method. </dd> 286N/A * <dt><code>"split-cdata-sections"</code></dt> 286N/A * <code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>)Split CDATA sections containing the CDATA section termination marker 286N/A * ']]>'. When a CDATA section is split a warning is issued with a 286N/A * <code>DOMError.type</code> equals to 286N/A * <code>"cdata-sections-splitted"</code> and 286N/A * <code>DOMError.relatedData</code> equals to the first 286N/A * <code>CDATASection</code> node in document order resulting from the split.</dd> 286N/A * <code>false</code></dt> 286N/A * <dd>[<em>required</em>]Signal an error if a <code>CDATASection</code> contains an 286N/A * unrepresentable character.</dd> 286N/A * <dt><code>"validate"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * <dd>[<em>optional</em>] Require the validation against a schema (i.e. XML schema, DTD, any 286N/A * other type or representation of schema) of the document as it is being 286N/A * validation errors are found, or no schema was found, the error handler is 286N/A * notified. Schema-normalized values will not be exposed according to the 286N/A * schema in used unless the parameter "datatype-normalization" is 286N/A * <code>true</code>. This parameter will reevaluate: 286N/A * <li> Attribute nodes with 286N/A * <code>Attr.specified</code> equals to <code>false</code>, as specified in 286N/A * the description of the <code>Attr</code> interface; 286N/A * <li> The value of the 286N/A * attribute <code>Text.isElementContentWhitespace</code> for all 286N/A * <code>Text</code> nodes; 286N/A * <li> The value of the attribute 286N/A * <code>Attr.isId</code> for all <code>Attr</code> nodes; 286N/A * <code>Element.schemaTypeInfo</code> and <code>Attr.schemaTypeInfo</code>. 286N/A * <p ><b>Note:</b> "validate-if-schema" and "validate" are mutually 286N/A * exclusive, setting one of them to <code>true</code> will set the other 286N/A * one to <code>false</code>. Applications should also consider setting the 286N/A * parameter "well-formed" to <code>true</code>, which is the default for 286N/A * that option, when validating the document. </dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>) Do not accomplish schema processing, including the internal subset 286N/A * processing. Default attribute values information are kept. Note that 286N/A * validation might still happen if "validate-if-schema" is <code>true</code> 286N/A * <dt><code>"validate-if-schema"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * <dd>[<em>optional</em>]Enable validation only if a declaration for the document element can be 286N/A * found in a schema (independently of where it is found, i.e. XML schema, 286N/A * DTD, or any other type or representation of schema). If validation is 286N/A * enabled, this parameter has the same behavior as the parameter "validate" 286N/A * set to <code>true</code>. 286N/A * <p ><b>Note:</b> "validate-if-schema" and "validate" are mutually 286N/A * exclusive, setting one of them to <code>true</code> will set the other 286N/A * one to <code>false</code>. </dd> 286N/A * <dt><code>false</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>) No schema processing should be performed if the document has a schema, 286N/A * including internal subset processing. Default attribute values 286N/A * information are kept. Note that validation must still happen if "validate 286N/A * " is <code>true</code>. </dd> 286N/A * <dt><code>"well-formed"</code></dt> 286N/A * <dt><code>true</code></dt> 286N/A * <dd>[<em>required</em>] (<em>default</em>) Check if all nodes are XML well formed according to the XML version in 286N/A * <li> check if the attribute 286N/A * <code>Node.nodeName</code> contains invalid characters according to its 286N/A * node type and generate a <code>DOMError</code> of type 286N/A * <code>"wf-invalid-character-in-node-name"</code>, with a 286N/A * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary; 286N/A * the text content inside <code>Attr</code>, <code>Element</code>, 286N/A * <code>Comment</code>, <code>Text</code>, <code>CDATASection</code> nodes 286N/A * for invalid characters and generate a <code>DOMError</code> of type 286N/A * <code>"wf-invalid-character"</code>, with a 286N/A * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary; 286N/A * the data inside <code>ProcessingInstruction</code> nodes for invalid 286N/A * characters and generate a <code>DOMError</code> of type 286N/A * <code>"wf-invalid-character"</code>, with a 286N/A * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary; 286N/A * <code>false</code></dt> 286N/A * <dd>[<em>optional</em>] Do not check for XML well-formedness. </dd> 286N/A * <p> The resolution of the system identifiers associated with entities is 286N/A * done using <code>Document.documentURI</code>. However, when the feature 286N/A * is supported by the DOM implementation, the parameter 286N/A * "resource-resolver" can also be used on <code>DOMConfiguration</code> 286N/A * objects attached to <code>Document</code> nodes. If this parameter is 286N/A * set, <code>Document.normalizeDocument()</code> will invoke the resource 286N/A * resolver instead of using <code>Document.documentURI</code>. 286N/A * Set the value of a parameter. 286N/A * @param name The name of the parameter to set. 286N/A * @param value The new value or <code>null</code> if the user wishes to 286N/A * unset the parameter. While the type of the value parameter is 286N/A * defined as <code>DOMUserData</code>, the object type must match the 286N/A * type defined by the definition of the parameter. For example, if 286N/A * the parameter is "error-handler", the value must be of type 286N/A * <code>DOMErrorHandler</code>. 286N/A * @exception DOMException 286N/A * NOT_FOUND_ERR: Raised when the parameter name is not recognized. 286N/A * <br> NOT_SUPPORTED_ERR: Raised when the parameter name is recognized 286N/A * but the requested value cannot be set. 286N/A * <br> TYPE_MISMATCH_ERR: Raised if the value type for this parameter 286N/A * name is incompatible with the expected value type. 286N/A * Return the value of a parameter if known. 286N/A * @param name The name of the parameter. 286N/A * @return The current object associated with the specified parameter or 286N/A * <code>null</code> if no object has been associated or if the 286N/A * parameter is not supported. 286N/A * @exception DOMException 286N/A * NOT_FOUND_ERR: Raised when the parameter name is not recognized. 286N/A * Check if setting a parameter to a specific value is supported. 286N/A * @param name The name of the parameter to check. 286N/A * @param value An object. if <code>null</code>, the returned value is 286N/A * @return <code>true</code> if the parameter could be successfully set 286N/A * to the specified value, or <code>false</code> if the parameter is 286N/A * not recognized or the requested value is not supported. This does 286N/A * not change the current value of the parameter itself. 286N/A * The list of the parameters supported by this 286N/A * <code>DOMConfiguration</code> object and for which at least one value 286N/A * can be set by the application. Note that this list can also contain 286N/A * parameter names defined outside this specification.