gnu.xml.stream

Class XMLEventImpl

Implemented Interfaces:
XMLEvent, XMLStreamConstants
Known Direct Subclasses:
AttributeImpl, CharactersImpl, CommentImpl, DTDImpl, EndDocumentImpl, EndElementImpl, EntityDeclarationImpl, EntityReferenceImpl, NamespaceImpl, NotationDeclarationImpl, ProcessingInstructionImpl, StartDocumentImpl, StartElementImpl

public abstract class XMLEventImpl
extends Object
implements XMLEvent

An XML stream event.

Field Summary

protected Location
location

Fields inherited from interface javax.xml.stream.XMLStreamConstants

ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT

Constructor Summary

XMLEventImpl(Location location)

Method Summary

Characters
asCharacters()
Returns this event as a text event.
EndElement
asEndElement()
Returns this event as an end-element event.
StartElement
asStartElement()
Returns this event as a start-element event.
protected String
encode(String text, boolean inAttr)
abstract int
getEventType()
Returns the type of this event.
Location
getLocation()
Returns the location of this event.
QName
getSchemaType()
Returns schema-related type information about this event, or null if not available.
boolean
isAttribute()
Indicates whether this event is an attribute event.
boolean
isCharacters()
Indicates whether this event is a text event.
boolean
isEndDocument()
Indicates whether this event is an end-document event.
boolean
isEndElement()
Indicates whether this event is an end-element event.
boolean
isEntityReference()
Indicates whether this event is an entity reference event.
boolean
isNamespace()
Indicates whether this event is a namespace declaration event.
boolean
isProcessingInstruction()
Indicates whether this event is a processing instruction event.
boolean
isStartDocument()
Indicates whether this event is a start-document event.
boolean
isStartElement()
Indicates whether this event is a start-element event.
abstract void
writeAsEncodedUnicode(Writer writer)
Writes this event to the specified writer.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

location

protected final Location location

Constructor Details

XMLEventImpl

protected XMLEventImpl(Location location)

Method Details

asCharacters

public Characters asCharacters()
Returns this event as a text event.
Specified by:
asCharacters in interface XMLEvent

asEndElement

public EndElement asEndElement()
Returns this event as an end-element event.
Specified by:
asEndElement in interface XMLEvent

asStartElement

public StartElement asStartElement()
Returns this event as a start-element event.
Specified by:
asStartElement in interface XMLEvent

encode

protected String encode(String text,
                        boolean inAttr)

getEventType

public abstract int getEventType()
Returns the type of this event.
Specified by:
getEventType in interface XMLEvent

getLocation

public Location getLocation()
Returns the location of this event.
Specified by:
getLocation in interface XMLEvent

getSchemaType

public QName getSchemaType()
Returns schema-related type information about this event, or null if not available.
Specified by:
getSchemaType in interface XMLEvent

isAttribute

public boolean isAttribute()
Indicates whether this event is an attribute event.
Specified by:
isAttribute in interface XMLEvent

isCharacters

public boolean isCharacters()
Indicates whether this event is a text event.
Specified by:
isCharacters in interface XMLEvent

isEndDocument

public boolean isEndDocument()
Indicates whether this event is an end-document event.
Specified by:
isEndDocument in interface XMLEvent

isEndElement

public boolean isEndElement()
Indicates whether this event is an end-element event.
Specified by:
isEndElement in interface XMLEvent

isEntityReference

public boolean isEntityReference()
Indicates whether this event is an entity reference event.
Specified by:
isEntityReference in interface XMLEvent

isNamespace

public boolean isNamespace()
Indicates whether this event is a namespace declaration event.
Specified by:
isNamespace in interface XMLEvent

isProcessingInstruction

public boolean isProcessingInstruction()
Indicates whether this event is a processing instruction event.
Specified by:
isProcessingInstruction in interface XMLEvent

isStartDocument

public boolean isStartDocument()
Indicates whether this event is a start-document event.
Specified by:
isStartDocument in interface XMLEvent

isStartElement

public boolean isStartElement()
Indicates whether this event is a start-element event.
Specified by:
isStartElement in interface XMLEvent

writeAsEncodedUnicode

public abstract void writeAsEncodedUnicode(Writer writer)
            throws XMLStreamException
Writes this event to the specified writer.
Specified by:
writeAsEncodedUnicode in interface XMLEvent

XMLEventImpl.java -- Copyright (C) 2005,2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.