Source for gnu.xml.stream.XMLEventImpl

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