com.ctc.wstx.evt
Class WEntityDeclaration

java.lang.Object
  extended by com.ctc.wstx.evt.WEvent
      extended by com.ctc.wstx.evt.WEntityDeclaration
All Implemented Interfaces:
javax.xml.stream.events.EntityDeclaration, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants, XMLEvent2
Direct Known Subclasses:
EntityDecl

public abstract class WEntityDeclaration
extends WEvent
implements javax.xml.stream.events.EntityDeclaration

Simple implementation of StAX entity declaration events; for the most just wraps a EntityDecl instance.


Field Summary
 
Fields inherited from class com.ctc.wstx.evt.WEvent
mLocation
 
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
WEntityDeclaration(javax.xml.stream.Location loc)
           
 
Method Summary
abstract  java.lang.String getBaseURI()
           
 int getEventType()
           
abstract  java.lang.String getName()
           
abstract  java.lang.String getNotationName()
           
abstract  java.lang.String getPublicId()
           
abstract  java.lang.String getReplacementText()
           
abstract  java.lang.String getSystemId()
           
 void writeAsEncodedUnicode(java.io.Writer w)
           
abstract  void writeEnc(java.io.Writer w)
           
 void writeUsing(javax.xml.stream.XMLStreamWriter w)
          This method does not make much sense for this event type -- the reason being that the entity declarations can only be written as part of a DTD (internal or external subset), not separately.
 
Methods inherited from class com.ctc.wstx.evt.WEvent
asCharacters, asEndElement, asStartElement, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, throwFromIOE, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.xml.stream.events.XMLEvent
asCharacters, asEndElement, asStartElement, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement
 

Constructor Detail

WEntityDeclaration

public WEntityDeclaration(javax.xml.stream.Location loc)
Method Detail

getBaseURI

public abstract java.lang.String getBaseURI()
Specified by:
getBaseURI in interface javax.xml.stream.events.EntityDeclaration

getName

public abstract java.lang.String getName()
Specified by:
getName in interface javax.xml.stream.events.EntityDeclaration

getNotationName

public abstract java.lang.String getNotationName()
Specified by:
getNotationName in interface javax.xml.stream.events.EntityDeclaration

getPublicId

public abstract java.lang.String getPublicId()
Specified by:
getPublicId in interface javax.xml.stream.events.EntityDeclaration

getReplacementText

public abstract java.lang.String getReplacementText()
Specified by:
getReplacementText in interface javax.xml.stream.events.EntityDeclaration

getSystemId

public abstract java.lang.String getSystemId()
Specified by:
getSystemId in interface javax.xml.stream.events.EntityDeclaration

getEventType

public int getEventType()
Specified by:
getEventType in interface javax.xml.stream.events.XMLEvent
Specified by:
getEventType in class WEvent

writeEnc

public abstract void writeEnc(java.io.Writer w)
                       throws java.io.IOException
Throws:
java.io.IOException

writeAsEncodedUnicode

public void writeAsEncodedUnicode(java.io.Writer w)
                           throws javax.xml.stream.XMLStreamException
Specified by:
writeAsEncodedUnicode in interface javax.xml.stream.events.XMLEvent
Specified by:
writeAsEncodedUnicode in class WEvent
Throws:
javax.xml.stream.XMLStreamException

writeUsing

public void writeUsing(javax.xml.stream.XMLStreamWriter w)
                throws javax.xml.stream.XMLStreamException
This method does not make much sense for this event type -- the reason being that the entity declarations can only be written as part of a DTD (internal or external subset), not separately. Can basically choose to either skip silently (output nothing), or throw an exception.

Specified by:
writeUsing in interface XMLEvent2
Specified by:
writeUsing in class WEvent
Throws:
javax.xml.stream.XMLStreamException