Top Description Fields Constructors Methods
com.sun.xml.internal.stream.events

public Class EntityReferenceEvent

extends DummyEvent
implements EntityReference
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.EntityReference, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
javax.xml.stream.events.EntityReference, .EntityDeclaration, .XMLEvent, java.io.Writer
Implements EntityReference event.
Author
Neeraj Bajaj, Sun Microsystems,

Field Summary

Modifier and TypeField and Description
private EntityDeclaration
fEntityDeclaration

private String
fEntityName

Inherited from com.sun.xml.internal.stream.events.DummyEvent:
fLocation

Constructor Summary

AccessConstructor and Description
public
EntityReferenceEvent()

public
EntityReferenceEvent(String entityName, EntityDeclaration entityDeclaration)

Method Summary

Modifier and TypeMethod and Description
public EntityDeclaration
getDeclaration()

Implements javax.xml.stream.events.EntityReference.getDeclaration.

Return the declaration of this entity.

public String
getName()

Implements javax.xml.stream.events.EntityReference.getName.

The name of the entity

protected void
init()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

protected void
writeAsEncodedUnicodeEx(Writer
The writer that will output the data
writer)

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Inherited from com.sun.xml.internal.stream.events.DummyEvent:
asCharactersasEndElementasStartElementcharEncodegetEventTypegetLocationgetSchemaTypeisAttributeisCharacterDataisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementsetEventTypesetLocationwriteAsEncodedUnicode

Field Detail

fEntityDeclarationback to summary
private EntityDeclaration fEntityDeclaration
fEntityNameback to summary
private String fEntityName

Constructor Detail

EntityReferenceEventback to summary
public EntityReferenceEvent()
EntityReferenceEventback to summary
public EntityReferenceEvent(String entityName, EntityDeclaration entityDeclaration)

Method Detail

getDeclarationback to summary
public EntityDeclaration getDeclaration()

Implements javax.xml.stream.events.EntityReference.getDeclaration.

Doc from javax.xml.stream.events.EntityReference.getDeclaration.

Return the declaration of this entity.

Returns:EntityDeclaration

the declaration

getNameback to summary
public String getName()

Implements javax.xml.stream.events.EntityReference.getName.

Doc from javax.xml.stream.events.EntityReference.getName.

The name of the entity

Returns:String

the entity's name, may not be null

initback to summary
protected void init()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

writeAsEncodedUnicodeExback to summary
protected void writeAsEncodedUnicodeEx(Writer writer) throws IOException

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Doc from com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Parameters
writer:Writer

The writer that will output the data

Exceptions
IOException:
if there is an IO error