Home | History | Annotate | Download | only in dom
      1 /*
      2  * Copyright (c) 2004 World Wide Web Consortium,
      3  *
      4  * (Massachusetts Institute of Technology, European Research Consortium for
      5  * Informatics and Mathematics, Keio University). All Rights Reserved. This
      6  * work is distributed under the W3C(r) Software License [1] in the hope that
      7  * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
      8  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
      9  *
     10  * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
     11  */
     12 
     13 package org.w3c.dom;
     14 
     15 /**
     16  * The <code>ProcessingInstruction</code> interface represents a "processing
     17  * instruction", used in XML as a way to keep processor-specific information
     18  * in the text of the document.
     19  * <p> No lexical check is done on the content of a processing instruction and
     20  * it is therefore possible to have the character sequence
     21  * <code>"?&gt;"</code> in the content, which is illegal a processing
     22  * instruction per section 2.6 of [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>]. The
     23  * presence of this character sequence must generate a fatal error during
     24  * serialization.
     25  * <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>.
     26  */
     27 public interface ProcessingInstruction extends Node {
     28     /**
     29      * The target of this processing instruction. XML defines this as being
     30      * the first token following the markup that begins the processing
     31      * instruction.
     32      */
     33     public String getTarget();
     34 
     35     /**
     36      * The content of this processing instruction. This is from the first non
     37      * white space character after the target to the character immediately
     38      * preceding the <code>?&gt;</code>.
     39      */
     40     public String getData();
     41     /**
     42      * The content of this processing instruction. This is from the first non
     43      * white space character after the target to the character immediately
     44      * preceding the <code>?&gt;</code>.
     45      * @exception DOMException
     46      *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
     47      */
     48     public void setData(String data)
     49                                    throws DOMException;
     50 
     51 }
     52