libjava/classpath/gnu/xml/stream/XMLEventImpl.java

   1 /* XMLEventImpl.java --
   2    Copyright (C) 2005,2006  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.stream;
  39
  40 import gnu.java.lang.CPStringBuilder;
  41
  42 import java.io.Writer;
  43 import javax.xml.namespace.QName;
  44 import javax.xml.stream.Location;
  45 import javax.xml.stream.XMLStreamException;
  46 import javax.xml.stream.events.Characters;
  47 import javax.xml.stream.events.EndElement;
  48 import javax.xml.stream.events.StartElement;
  49 import javax.xml.stream.events.XMLEvent;
  50
  51 /**
  52  * An XML stream event.
  53  *
  54  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  55  */
  56 public abstract class XMLEventImpl
  57   implements XMLEvent
  58 {
  59
  60   protected final Location location;
  61
  62   protected XMLEventImpl(Location location)
  63   {
  64     this.location = location;
  65   }
  66
  67   public abstract int getEventType();
  68
  69   public Location getLocation()
  70   {
  71     return location;
  72   }
  73
  74   public boolean isStartElement()
  75   {
  76     return getEventType() == START_ELEMENT;
  77   }
  78
  79   public boolean isAttribute()
  80   {
  81     return getEventType() == ATTRIBUTE;
  82   }
  83
  84   public boolean isNamespace()
  85   {
  86     return getEventType() == NAMESPACE;
  87   }
  88
  89   public boolean isEndElement()
  90   {
  91     return getEventType() == END_ELEMENT;
  92   }
  93
  94   public boolean isEntityReference()
  95   {
  96     return getEventType() == ENTITY_REFERENCE;
  97   }
  98
  99   public boolean isProcessingInstruction()
 100   {
 101     return getEventType() == PROCESSING_INSTRUCTION;
 102   }
 103
 104   public boolean isCharacters()
 105   {
 106     int et = getEventType();
 107     return et == CHARACTERS || et == CDATA;
 108   }
 109
 110   public boolean isStartDocument()
 111   {
 112     return getEventType() == START_DOCUMENT;
 113   }
 114
 115   public boolean isEndDocument()
 116   {
 117     return getEventType() == END_DOCUMENT;
 118   }
 119
 120   public StartElement asStartElement()
 121   {
 122     return (StartElement) this;
 123   }
 124
 125   public EndElement asEndElement()
 126   {
 127     return (EndElement) this;
 128   }
 129
 130   public Characters asCharacters()
 131   {
 132     return (Characters) this;
 133   }
 134
 135   public QName getSchemaType()
 136   {
 137     return null;
 138   }
 139
 140   public abstract void writeAsEncodedUnicode(Writer writer)
 141     throws XMLStreamException;
 142
 143   protected String encode(String text, boolean inAttr)
 144   {
 145     int len = text.length();
 146     CPStringBuilder buf = null;
 147     for (int i = 0; i < len; i++)
 148       {
 149         char c = text.charAt(i);
 150         if (c == '<')
 151           {
 152             if (buf == null)
 153               {
 154                 buf = new CPStringBuilder(text.substring(0, i));
 155               }
 156             buf.append("&lt;");
 157           }
 158         else if (c == '>')
 159           {
 160             if (buf == null)
 161               {
 162                 buf = new CPStringBuilder(text.substring(0, i));
 163               }
 164             buf.append("&gt;");
 165           }
 166         else if (c == '&')
 167           {
 168             if (buf == null)
 169               {
 170                 buf = new CPStringBuilder(text.substring(0, i));
 171               }
 172             buf.append("&amp;");
 173           }
 174         else if (c == '\'' && inAttr)
 175           {
 176             if (buf == null)
 177               {
 178                 buf = new CPStringBuilder(text.substring(0, i));
 179               }
 180             buf.append("&apos;");
 181           }
 182         else if (c == '"' && inAttr)
 183           {
 184             if (buf == null)
 185               {
 186                 buf = new CPStringBuilder(text.substring(0, i));
 187               }
 188             buf.append("&quot;");
 189           }
 190         else if (buf != null)
 191           {
 192             buf.append(c);
 193           }
 194       }
 195     return (buf == null) ? text : buf.toString();
 196   }
 197
 198 }
 199