src/org/w3c/dom/DOMConfiguration.java

Print this page
rev 602 : 8047723: @since tag cleanup in jaxp
Reviewed-by:


 366  * the data inside <code>ProcessingInstruction</code> nodes for invalid
 367  * characters and generate a <code>DOMError</code> of type
 368  * <code>"wf-invalid-character"</code>, with a
 369  * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary;
 370  * </li>
 371  * </ul></dd>
 372  * <dt>
 373  * <code>false</code></dt>
 374  * <dd>[<em>optional</em>] Do not check for XML well-formedness. </dd>
 375  * </dl></dd>
 376  * </dl>
 377  * <p> The resolution of the system identifiers associated with entities is
 378  * done using <code>Document.documentURI</code>. However, when the feature
 379  * "LS" defined in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>DOM Level 3 Load and Save</a>]
 380  *  is supported by the DOM implementation, the parameter
 381  * "resource-resolver" can also be used on <code>DOMConfiguration</code>
 382  * objects attached to <code>Document</code> nodes. If this parameter is
 383  * set, <code>Document.normalizeDocument()</code> will invoke the resource
 384  * resolver instead of using <code>Document.documentURI</code>.
 385  * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
 386  * @since DOM Level 3
 387  */
 388 public interface DOMConfiguration {
 389     /**
 390      * Set the value of a parameter.
 391      * @param name The name of the parameter to set.
 392      * @param value  The new value or <code>null</code> if the user wishes to
 393      *   unset the parameter. While the type of the value parameter is
 394      *   defined as <code>DOMUserData</code>, the object type must match the
 395      *   type defined by the definition of the parameter. For example, if
 396      *   the parameter is "error-handler", the value must be of type
 397      *   <code>DOMErrorHandler</code>.
 398      * @exception DOMException
 399      *    NOT_FOUND_ERR: Raised when the parameter name is not recognized.
 400      *   <br> NOT_SUPPORTED_ERR: Raised when the parameter name is recognized
 401      *   but the requested value cannot be set.
 402      *   <br> TYPE_MISMATCH_ERR: Raised if the value type for this parameter
 403      *   name is incompatible with the expected value type.
 404      */
 405     public void setParameter(String name,
 406                              Object value)




 366  * the data inside <code>ProcessingInstruction</code> nodes for invalid
 367  * characters and generate a <code>DOMError</code> of type
 368  * <code>"wf-invalid-character"</code>, with a
 369  * <code>DOMError.SEVERITY_ERROR</code> severity, if necessary;
 370  * </li>
 371  * </ul></dd>
 372  * <dt>
 373  * <code>false</code></dt>
 374  * <dd>[<em>optional</em>] Do not check for XML well-formedness. </dd>
 375  * </dl></dd>
 376  * </dl>
 377  * <p> The resolution of the system identifiers associated with entities is
 378  * done using <code>Document.documentURI</code>. However, when the feature
 379  * "LS" defined in [<a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>DOM Level 3 Load and Save</a>]
 380  *  is supported by the DOM implementation, the parameter
 381  * "resource-resolver" can also be used on <code>DOMConfiguration</code>
 382  * objects attached to <code>Document</code> nodes. If this parameter is
 383  * set, <code>Document.normalizeDocument()</code> will invoke the resource
 384  * resolver instead of using <code>Document.documentURI</code>.
 385  * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
 386  * @since 1.5, DOM Level 3
 387  */
 388 public interface DOMConfiguration {
 389     /**
 390      * Set the value of a parameter.
 391      * @param name The name of the parameter to set.
 392      * @param value  The new value or <code>null</code> if the user wishes to
 393      *   unset the parameter. While the type of the value parameter is
 394      *   defined as <code>DOMUserData</code>, the object type must match the
 395      *   type defined by the definition of the parameter. For example, if
 396      *   the parameter is "error-handler", the value must be of type
 397      *   <code>DOMErrorHandler</code>.
 398      * @exception DOMException
 399      *    NOT_FOUND_ERR: Raised when the parameter name is not recognized.
 400      *   <br> NOT_SUPPORTED_ERR: Raised when the parameter name is recognized
 401      *   but the requested value cannot be set.
 402      *   <br> TYPE_MISMATCH_ERR: Raised if the value type for this parameter
 403      *   name is incompatible with the expected value type.
 404      */
 405     public void setParameter(String name,
 406                              Object value)