View Javadoc
1   /*
2    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3    *
4    * This code is free software; you can redistribute it and/or modify it
5    * under the terms of the GNU General Public License version 2 only, as
6    * published by the Free Software Foundation.  Oracle designates this
7    * particular file as subject to the "Classpath" exception as provided
8    * by Oracle in the LICENSE file that accompanied this code.
9    *
10   * This code is distributed in the hope that it will be useful, but WITHOUT
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
13   * version 2 for more details (a copy is included in the LICENSE file that
14   * accompanied this code).
15   *
16   * You should have received a copy of the GNU General Public License version
17   * 2 along with this work; if not, write to the Free Software Foundation,
18   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19   *
20   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21   * or visit www.oracle.com if you need additional information or have any
22   * questions.
23   */
24  
25  /*
26   * This file is available under and governed by the GNU General Public
27   * License version 2 only, as published by the Free Software Foundation.
28   * However, the following notice accompanied the original version of this
29   * file and, per its terms, should not be removed:
30   *
31   * Copyright (c) 2004 World Wide Web Consortium,
32   *
33   * (Massachusetts Institute of Technology, European Research Consortium for
34   * Informatics and Mathematics, Keio University). All Rights Reserved. This
35   * work is distributed under the W3C(r) Software License [1] in the hope that
36   * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
37   * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
38   *
39   * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
40   */
41  
42  package org.w3c.dom;
43  
44  /**
45   * The <code>ProcessingInstruction</code> interface represents a "processing
46   * instruction", used in XML as a way to keep processor-specific information
47   * in the text of the document.
48   * <p> No lexical check is done on the content of a processing instruction and
49   * it is therefore possible to have the character sequence
50   * <code>"?&gt;"</code> in the content, which is illegal a processing
51   * instruction per section 2.6 of [<a href='http://www.w3.org/TR/2004/REC-xml-20040204'>XML 1.0</a>]. The
52   * presence of this character sequence must generate a fatal error during
53   * serialization.
54   * <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>.
55   */
56  public interface ProcessingInstruction extends Node {
57      /**
58       * The target of this processing instruction. XML defines this as being
59       * the first token following the markup that begins the processing
60       * instruction.
61       */
62      public String getTarget();
63  
64      /**
65       * The content of this processing instruction. This is from the first non
66       * white space character after the target to the character immediately
67       * preceding the <code>?&gt;</code>.
68       */
69      public String getData();
70      /**
71       * The content of this processing instruction. This is from the first non
72       * white space character after the target to the character immediately
73       * preceding the <code>?&gt;</code>.
74       * @exception DOMException
75       *   NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
76       */
77      public void setData(String data)
78                                     throws DOMException;
79  
80  }