Source for gnu.xml.dom.DomProcessingInstruction

   1: /* DomProcessingInstruction.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., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 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.DOMException;
  41: import org.w3c.dom.ProcessingInstruction;
  42: 
  43: /**
  44:  * <p> "ProcessingInstruction" (PI) implementation.
  45:  * This is a non-core DOM class, supporting the "XML" feature. </p>
  46:  *
  47:  * <p> Unlike other DOM APIs in the "XML" feature, this one fully
  48:  * exposes the functionality it describes.  So there is no reason
  49:  * inherent in DOM to avoid using this API, unless you want to rely
  50:  * on NOTATION declarations to associate meaning with your PIs;
  51:  * there is no vendor-neutal way to record those notations in DOM.</p>
  52:  *
  53:  * <p> Also of note is that PI support is part of SAX, so that XML
  54:  * systems using PIs can choose among multiple APIs. </p>
  55:  *
  56:  * @see DomNotation
  57:  *
  58:  * @author David Brownell
  59:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  60:  */
  61: public class DomProcessingInstruction
  62:   extends DomNode
  63:   implements ProcessingInstruction
  64: {
  65: 
  66:   private String target;
  67:   private String data;
  68: 
  69:   /**
  70:    * Constructs a ProcessingInstruction node associated with the
  71:    * specified document, with the specified data.
  72:    *
  73:    * <p>This constructor should only be invoked by a Document object as
  74:    * part of its createProcessingInstruction functionality, or through
  75:    * a subclass which is similarly used in a "Sub-DOM" style layer.
  76:    */
  77:   protected DomProcessingInstruction(DomDocument owner,
  78:                                      String target, String data)
  79:   {
  80:     super(PROCESSING_INSTRUCTION_NODE, owner);
  81:     this.target = target;
  82:     this.data = data;
  83:   }
  84: 
  85:   /**
  86:    * <b>DOM L1</b>
  87:    * Returns the target of the processing instruction.
  88:    */
  89:   public final String getTarget()
  90:   {
  91:     return target;
  92:   }
  93: 
  94:   /**
  95:    * <b>DOM L1</b>
  96:    * Returns the target of the processing instruction
  97:    * (same as getTarget).
  98:    */
  99:   public final String getNodeName()
 100:   {
 101:     return target;
 102:   }
 103: 
 104:   /**
 105:    * <b>DOM L1</b>
 106:    * Returns the data associated with the processing instruction.
 107:    */
 108:   public final String getData()
 109:   {
 110:     return data;
 111:   }
 112: 
 113:   /**
 114:    * <b>DOM L1</b>
 115:    * Returns the data associated with the processing instruction
 116:    * (same as getData).
 117:    */
 118:   public final String getNodeValue()
 119:   {
 120:     return data;
 121:   }
 122: 
 123:   /**
 124:    * <b>DOM L1</b>
 125:    * Assigns the data associated with the processing instruction;
 126:    * same as setNodeValue.
 127:    */
 128:   public final void setData(String data)
 129:   {
 130:     setNodeValue(data);
 131:   }
 132: 
 133:   /**
 134:    * <b>DOM L1</b>
 135:    * Assigns the data associated with the processing instruction.
 136:    */
 137:   public final void setNodeValue(String data)
 138:   {
 139:     if (isReadonly())
 140:       {
 141:         throw new DomDOMException(DOMException.NO_MODIFICATION_ALLOWED_ERR);
 142:       }
 143:     this.data = data;
 144:   }
 145: 
 146: }