Top Fields Constructors Methods
org.codehaus.stax2.ri.evt

public Class EntityReferenceEventImpl

extends BaseEventImpl
implements EntityReference
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.EntityReference, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
java.io.IOException, .Writer, javax.xml.stream.*, javax.xml.stream.events.EntityReference, .EntityDeclaration, org.codehaus.stax2.XMLStreamWriter2

Field Summary

Modifier and TypeField and Description
protected final EntityDeclaration
Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:
mLocation

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Declared abstract to force redefinition by sub-classes
public EntityDeclaration
getDeclaration()

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

Return the declaration of this entity.
public int
getEventType()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType.

Implements javax.xml.stream.events.XMLEvent.getEventType.

Returns an integer code for this event.
public String
getName()

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

The name of the entity
public int
hashCode()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Declared abstract to force redefinition by sub-classes
public boolean
isEntityReference()

Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.isEntityReference.

Implements javax.xml.stream.events.XMLEvent.isEntityReference.

A utility function to check if this event is an EntityReference.
public void
writeAsEncodedUnicode(Writer
The writer that will output the data
w
)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode.

Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
public void
Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:
addHashasCharactersasEndElementasStartElementgetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEndElementisNamespaceisProcessingInstructionisStartDocumentisStartElementiteratedEqualsstringsWithNullsEqualthrowFromIOEtoString

Field Detail

mDeclback to summary
protected final EntityDeclaration mDecl

Constructor Detail

EntityReferenceEventImplback to summary
public EntityReferenceEventImpl(Location loc, EntityDeclaration decl)
EntityReferenceEventImplback to summary
public EntityReferenceEventImpl(Location loc, String name)

Method Detail

equalsback to summary
public boolean equals(Object o)

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.equals.

Declared abstract to force redefinition by sub-classes

Parameters
o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
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

Annotations
@Override
getEventTypeback to summary
public int getEventType()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.getEventType.

Implements javax.xml.stream.events.XMLEvent.getEventType.

Doc from javax.xml.stream.events.XMLEvent.getEventType.

Returns an integer code for this event.

Returns:int

the event type

Annotations
@Override
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

Annotations
@Override
hashCodeback to summary
public int hashCode()

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Doc from org.codehaus.stax2.ri.evt.BaseEventImpl.hashCode.

Declared abstract to force redefinition by sub-classes

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations
@Override
isEntityReferenceback to summary
public boolean isEntityReference()

Overrides org.codehaus.stax2.ri.evt.BaseEventImpl.isEntityReference.

Implements javax.xml.stream.events.XMLEvent.isEntityReference.

Doc from javax.xml.stream.events.XMLEvent.isEntityReference.

A utility function to check if this event is an EntityReference.

Returns:boolean

true if the event is EntityReference, false otherwise

Annotations
@Override
writeAsEncodedUnicodeback to summary
public void writeAsEncodedUnicode(Writer w) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeAsEncodedUnicode.

Implements javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

Doc from javax.xml.stream.events.XMLEvent.writeAsEncodedUnicode.

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.

Parameters
w:Writer

The writer that will output the data

Annotations
@Override
Exceptions
XMLStreamException:
if there is a fatal error writing the event
writeUsingback to summary
public void writeUsing(XMLStreamWriter2 w) throws XMLStreamException

Implements abstract org.codehaus.stax2.ri.evt.BaseEventImpl.writeUsing.

Implements org.codehaus.stax2.evt.XMLEvent2.writeUsing.

Annotations
@Override