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

public Class EndElementEventImpl

extends BaseEventImpl
implements EndElement
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.EndElement, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
java.io.IOException, .Writer, java.util.ArrayList, .Iterator, javax.xml.namespace.QName, javax.xml.stream.Location, .XMLStreamException, .XMLStreamReader, javax.xml.stream.events.EndElement, .Namespace, org.codehaus.stax2.XMLStreamWriter2, org.codehaus.stax2.ri.EmptyIterator, org.codehaus.stax2.ri.evt.BaseEventImpl

Field Summary

Modifier and TypeField and Description
protected final QName
protected final ArrayList<Namespace>
Inherited from org.codehaus.stax2.ri.evt.BaseEventImpl:
mLocation

Constructor Summary

AccessConstructor and Description
public
EndElementEventImpl(Location loc, XMLStreamReader r)

Constructor usually used when reading events from a stream reader.

public
EndElementEventImpl(Location loc, QName name, Iterator<Namespace> namespaces)

Constructor used by the event factory.

Method Summary

Modifier and TypeMethod and Description
public EndElement
asEndElement()

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

Implements javax.xml.stream.events.XMLEvent.asEndElement.

Returns this event as an end element event, may result in a class cast exception if this event is not a end element.
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 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 QName
getName()

Implements javax.xml.stream.events.EndElement.getName.

Get the name of this event
public Iterator<Namespace>
getNamespaces()

Implements javax.xml.stream.events.EndElement.getNamespaces.

Returns an Iterator of namespaces that have gone out of scope.
public int
hashCode()

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

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

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

Implements javax.xml.stream.events.XMLEvent.isEndElement.

A utility function to check if this event is a EndElement.
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:
addHashasCharactersasStartElementgetLocationgetSchemaTypeisAttributeisCharactersisEndDocumentisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementiteratedEqualsstringsWithNullsEqualthrowFromIOEtoString

Field Detail

mNameback to summary
protected final QName mName
mNamespacesback to summary
protected final ArrayList<Namespace> mNamespaces

Constructor Detail

EndElementEventImplback to summary
public EndElementEventImpl(Location loc, XMLStreamReader r)

Constructor usually used when reading events from a stream reader.

EndElementEventImplback to summary
public EndElementEventImpl(Location loc, QName name, Iterator<Namespace> namespaces)

Constructor used by the event factory.

Method Detail

asEndElementback to summary
public EndElement asEndElement()

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

Implements javax.xml.stream.events.XMLEvent.asEndElement.

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

Returns this event as an end element event, may result in a class cast exception if this event is not a end element.

Returns:EndElement

a EndElement event

Annotations
@Override
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
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 QName getName()

Implements javax.xml.stream.events.EndElement.getName.

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

Get the name of this event

Returns:QName

the qualified name of this event

Annotations
@Override
getNamespacesback to summary
public Iterator<Namespace> getNamespaces()

Implements javax.xml.stream.events.EndElement.getNamespaces.

Doc from javax.xml.stream.events.EndElement.getNamespaces.

Returns an Iterator of namespaces that have gone out of scope. Returns an empty iterator if no namespaces have gone out of scope.

Returns:Iterator<Namespace>

an Iterator over Namespace interfaces, or an empty iterator

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
isEndElementback to summary
public boolean isEndElement()

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

Implements javax.xml.stream.events.XMLEvent.isEndElement.

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

A utility function to check if this event is a EndElement.

Returns:boolean

true if the event is EndElement, 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