com.sun.xml.stream.events
Class EntityReferenceEvent

java.lang.Object
  extended by com.sun.xml.stream.events.DummyEvent
      extended by com.sun.xml.stream.events.EntityReferenceEvent
All Implemented Interfaces:
javax.xml.stream.events.EntityReference, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

public class EntityReferenceEvent
extends DummyEvent
implements javax.xml.stream.events.EntityReference

Implements EntityReference event.

Author:
Neeraj Bajaj, Sun Microsystems,

Field Summary
 
Fields inherited from class com.sun.xml.stream.events.DummyEvent
fLocation
 
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
EntityReferenceEvent()
           
EntityReferenceEvent(java.lang.String entityName, javax.xml.stream.events.EntityDeclaration entityDeclaration)
           
 
Method Summary
 javax.xml.stream.events.EntityDeclaration getDeclaration()
           
 java.lang.String getName()
           
protected  void init()
           
 java.lang.String toString()
           
 void writeAsEncodedUnicode(java.io.Writer writer)
          This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
 
Methods inherited from class com.sun.xml.stream.events.DummyEvent
asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacterData, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, setEventType
 
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, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement
 

Constructor Detail

EntityReferenceEvent

public EntityReferenceEvent()

EntityReferenceEvent

public EntityReferenceEvent(java.lang.String entityName,
                            javax.xml.stream.events.EntityDeclaration entityDeclaration)
Method Detail

getName

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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

writeAsEncodedUnicode

public void writeAsEncodedUnicode(java.io.Writer writer)
                           throws javax.xml.stream.XMLStreamException
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. No indentation or whitespace should be outputted. Any user defined event type SHALL have this method called when being written to on an output stream. Built in Event types MUST implement this method, but implementations MAY choose not call these methods for optimizations reasons when writing out built in Events to an output stream. The output generated MUST be equivalent in terms of the infoset expressed.

Specified by:
writeAsEncodedUnicode in interface javax.xml.stream.events.XMLEvent
Overrides:
writeAsEncodedUnicode in class DummyEvent
Parameters:
writer - The writer that will output the data
Throws:
XMLStreamException - if there is a fatal error writing the event

getDeclaration

public javax.xml.stream.events.EntityDeclaration getDeclaration()
Specified by:
getDeclaration in interface javax.xml.stream.events.EntityReference

init

protected void init()


Copyright ? 2002-2003 Apache XML Project. All Rights Reserved.