libjava/gnu/xml/dom/DomPI.java

   1 /* DomPI.java --
   2    Copyright (C) 1999,2000,2001,2004 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package gnu.xml.dom;
  39
  40 import org.w3c.dom.ProcessingInstruction;
  41
  42 /**
  43  * <p> "ProcessingInstruction" (PI) implementation.
  44  * This is a non-core DOM class, supporting the "XML" feature. </p>
  45  *
  46  * <p> Unlike other DOM APIs in the "XML" feature, this one fully
  47  * exposes the functionality it describes.  So there is no reason
  48  * inherent in DOM to avoid using this API, unless you want to rely
  49  * on NOTATION declarations to associate meaning with your PIs;
  50  * there is no vendor-neutal way to record those notations in DOM.</p>
  51  *
  52  * <p> Also of note is that PI support is part of SAX, so that XML
  53  * systems using PIs can choose among multiple APIs. </p>
  54  *
  55  * @see DomNotation
  56  *
  57  * @author David Brownell
  58  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  59  */
  60 public class DomPI
  61   extends DomNode
  62   implements ProcessingInstruction
  63 {
  64
  65   private String target;
  66   private String data;
  67
  68   /**
  69    * Constructs a ProcessingInstruction node associated with the
  70    * specified document, with the specified data.
  71    *
  72    * <p>This constructor should only be invoked by a Document object as
  73    * part of its createProcessingInstruction functionality, or through
  74    * a subclass which is similarly used in a "Sub-DOM" style layer.
  75    */
  76   protected DomPI(DomDocument owner, String target, String data)
  77   {
  78     super(PROCESSING_INSTRUCTION_NODE, owner);
  79     this.target = target;
  80     this.data = data;
  81   }
  82
  83   /**
  84    * <b>DOM L1</b>
  85    * Returns the target of the processing instruction.
  86    */
  87   public final String getTarget()
  88   {
  89     return target;
  90   }
  91
  92   /**
  93    * <b>DOM L1</b>
  94    * Returns the target of the processing instruction
  95    * (same as getTarget).
  96    */
  97   public final String getNodeName()
  98   {
  99     return target;
 100   }
 101
 102   /**
 103    * <b>DOM L1</b>
 104    * Returns the data associated with the processing instruction.
 105    */
 106   public final String getData()
 107   {
 108     return data;
 109   }
 110
 111   /**
 112    * <b>DOM L1</b>
 113    * Returns the data associated with the processing instruction
 114    * (same as getData).
 115    */
 116   public final String getNodeValue()
 117   {
 118     return data;
 119   }
 120
 121   /**
 122    * <b>DOM L1</b>
 123    * Assigns the data associated with the processing instruction;
 124    * same as setNodeValue.
 125    */
 126   public final void setData(String data)
 127   {
 128     setNodeValue(data);
 129   }
 130
 131   /**
 132    * <b>DOM L1</b>
 133    * Assigns the data associated with the processing instruction.
 134    */
 135   public final void setNodeValue(String data)
 136   {
 137     if (isReadonly())
 138       {
 139         throw new DomEx(DomEx.NO_MODIFICATION_ALLOWED_ERR);
 140       }
 141     this.data = data;
 142   }
 143
 144 }
 145