Xerces2-j 2.12.2 · org.apache.xerces.stax.events.XMLEventImpl

Modifier and Type	Field and Description
private int	fEventType Constant representing the type of this event.
private Location	fLocation Location object for this event.

Access	Constructor and Description
pack-priv	XMLEventImpl(final int eventType, final Location location) Constructor.

Method Summary

Modifier and Type	Method and Description
public final Characters	asCharacters() Implements javax.xml.stream.events.XMLEvent.asCharacters. Returns this event as Characters, may result in a class cast exception if this event is not Characters.
public final EndElement	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 final StartElement	asStartElement() Implements javax.xml.stream.events.XMLEvent.asStartElement. Returns this event as a start element event, may result in a class cast exception if this event is not a start element.
public final int	getEventType() Implements javax.xml.stream.events.XMLEvent.getEventType. Returns an integer code for this event.
public final Location	getLocation() Implements javax.xml.stream.events.XMLEvent.getLocation. Return the location of this event.
public final QName	getSchemaType() Implements javax.xml.stream.events.XMLEvent.getSchemaType. This method is provided for implementations to provide optional type information about the associated event.
public final boolean	isAttribute() Implements javax.xml.stream.events.XMLEvent.isAttribute. A utility function to check if this event is an Attribute.
public final boolean	isCharacters() Implements javax.xml.stream.events.XMLEvent.isCharacters. A utility function to check if this event is Characters.
public final boolean	isEndDocument() Implements javax.xml.stream.events.XMLEvent.isEndDocument. A utility function to check if this event is an EndDocument.
public final boolean	isEndElement() Implements javax.xml.stream.events.XMLEvent.isEndElement. A utility function to check if this event is a EndElement.
public final boolean	isEntityReference() Implements javax.xml.stream.events.XMLEvent.isEntityReference. A utility function to check if this event is an EntityReference.
public final boolean	isNamespace() Implements javax.xml.stream.events.XMLEvent.isNamespace. A utility function to check if this event is a Namespace.
public final boolean	isProcessingInstruction() Implements javax.xml.stream.events.XMLEvent.isProcessingInstruction. A utility function to check if this event is a ProcessingInstruction.
public final boolean	isStartDocument() Implements javax.xml.stream.events.XMLEvent.isStartDocument. A utility function to check if this event is a StartDocument.
public final boolean	isStartElement() Implements javax.xml.stream.events.XMLEvent.isStartElement. A utility function to check if this event is a StartElement.
public final String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

fEventType	back to summary
private int fEventType Constant representing the type of this event. `javax.xml.stream.XMLStreamConstants` See Also `javax.xml.stream.XMLStreamConstants`

fLocation	back to summary
private Location fLocation Location object for this event.

XMLEventImpl	back to summary
pack-priv XMLEventImpl(final int eventType, final Location location) Constructor.

Method Detail

asCharacters back to summary

asCharacters	back to summary
public final Characters asCharacters() Implements javax.xml.stream.events.XMLEvent.asCharacters. Doc from javax.xml.stream.events.XMLEvent.asCharacters. Returns this event as Characters, may result in a class cast exception if this event is not Characters. Returns:Characters a `Characters` event See Also `javax.xml.stream.events.XMLEvent#asCharacters()`

public final Characters asCharacters()

Implements javax.xml.stream.events.XMLEvent.asCharacters.

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

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

Returns:Characters: a Characters event
See Also: javax.xml.stream.events.XMLEvent#asCharacters()

asEndElement back to summary

asEndElement	back to summary
public final EndElement 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 See Also `javax.xml.stream.events.XMLEvent#asEndElement()`

public final EndElement 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
See Also: javax.xml.stream.events.XMLEvent#asEndElement()

asStartElement back to summary

asStartElement	back to summary
public final StartElement asStartElement() Implements javax.xml.stream.events.XMLEvent.asStartElement. Doc from javax.xml.stream.events.XMLEvent.asStartElement. Returns this event as a start element event, may result in a class cast exception if this event is not a start element. Returns:StartElement a `StartElement` event See Also `javax.xml.stream.events.XMLEvent#asStartElement()`

public final StartElement asStartElement()

Implements javax.xml.stream.events.XMLEvent.asStartElement.

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

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

Returns:StartElement: a StartElement event
See Also: javax.xml.stream.events.XMLEvent#asStartElement()

getEventType back to summary

getEventType	back to summary
public final int 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 See Also `javax.xml.stream.events.XMLEvent#getEventType()`

public final int 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
See Also: javax.xml.stream.events.XMLEvent#getEventType()

getLocation back to summary

getLocation	back to summary
public final Location getLocation() Implements javax.xml.stream.events.XMLEvent.getLocation. Doc from javax.xml.stream.events.XMLEvent.getLocation. Return the location of this event. The Location returned from this method is non-volatile and will retain its information. Returns:Location the location of the event See Also `javax.xml.stream.events.XMLEvent#getLocation()`

public final Location getLocation()

Implements javax.xml.stream.events.XMLEvent.getLocation.

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

Return the location of this event. The Location returned from this method is non-volatile and will retain its information.

Returns:Location: the location of the event
See Also: javax.xml.stream.events.XMLEvent#getLocation()

getSchemaType back to summary

getSchemaType	back to summary
public final QName getSchemaType() Implements javax.xml.stream.events.XMLEvent.getSchemaType. Doc from javax.xml.stream.events.XMLEvent.getSchemaType. This method is provided for implementations to provide optional type information about the associated event. It is optional and will return null if no information is available. Returns:QName the type of the event, null if not available See Also `javax.xml.stream.events.XMLEvent#getSchemaType()`

public final QName getSchemaType()

Implements javax.xml.stream.events.XMLEvent.getSchemaType.

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

This method is provided for implementations to provide optional type information about the associated event. It is optional and will return null if no information is available.

Returns:QName: the type of the event, null if not available
See Also: javax.xml.stream.events.XMLEvent#getSchemaType()

isAttribute back to summary

isAttribute	back to summary
public final boolean isAttribute() Implements javax.xml.stream.events.XMLEvent.isAttribute. Doc from javax.xml.stream.events.XMLEvent.isAttribute. A utility function to check if this event is an Attribute. Returns:boolean true if the event is `Attribute`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isAttribute()`

public final boolean isAttribute()

Implements javax.xml.stream.events.XMLEvent.isAttribute.

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

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

Returns:boolean: true if the event is Attribute, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isAttribute()

isCharacters back to summary

isCharacters	back to summary
public final boolean isCharacters() Implements javax.xml.stream.events.XMLEvent.isCharacters. Doc from javax.xml.stream.events.XMLEvent.isCharacters. A utility function to check if this event is Characters. Returns:boolean true if the event is `Characters`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isCharacters()`

public final boolean isCharacters()

Implements javax.xml.stream.events.XMLEvent.isCharacters.

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

A utility function to check if this event is Characters.

Returns:boolean: true if the event is Characters, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isCharacters()

isEndDocument back to summary

isEndDocument	back to summary
public final boolean isEndDocument() Implements javax.xml.stream.events.XMLEvent.isEndDocument. Doc from javax.xml.stream.events.XMLEvent.isEndDocument. A utility function to check if this event is an EndDocument. Returns:boolean true if the event is `EndDocument`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isEndDocument()`

public final boolean isEndDocument()

Implements javax.xml.stream.events.XMLEvent.isEndDocument.

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

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

Returns:boolean: true if the event is EndDocument, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isEndDocument()

isEndElement back to summary

isEndElement	back to summary
public final boolean 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 See Also `javax.xml.stream.events.XMLEvent#isEndElement()`

public final boolean 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
See Also: javax.xml.stream.events.XMLEvent#isEndElement()

isEntityReference back to summary

isEntityReference	back to summary
public final boolean 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 See Also `javax.xml.stream.events.XMLEvent#isEntityReference()`

public final boolean 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
See Also: javax.xml.stream.events.XMLEvent#isEntityReference()

isNamespace back to summary

isNamespace	back to summary
public final boolean isNamespace() Implements javax.xml.stream.events.XMLEvent.isNamespace. Doc from javax.xml.stream.events.XMLEvent.isNamespace. A utility function to check if this event is a Namespace. Returns:boolean true if the event is `Namespace`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isNamespace()`

public final boolean isNamespace()

Implements javax.xml.stream.events.XMLEvent.isNamespace.

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

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

Returns:boolean: true if the event is Namespace, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isNamespace()

isProcessingInstruction back to summary

isProcessingInstruction	back to summary
public final boolean isProcessingInstruction() Implements javax.xml.stream.events.XMLEvent.isProcessingInstruction. Doc from javax.xml.stream.events.XMLEvent.isProcessingInstruction. A utility function to check if this event is a ProcessingInstruction. Returns:boolean true if the event is `ProcessingInstruction`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isProcessingInstruction()`

public final boolean isProcessingInstruction()

Implements javax.xml.stream.events.XMLEvent.isProcessingInstruction.

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

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

Returns:boolean: true if the event is ProcessingInstruction, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isProcessingInstruction()

isStartDocument back to summary

isStartDocument	back to summary
public final boolean isStartDocument() Implements javax.xml.stream.events.XMLEvent.isStartDocument. Doc from javax.xml.stream.events.XMLEvent.isStartDocument. A utility function to check if this event is a StartDocument. Returns:boolean true if the event is `StartDocument`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isStartDocument()`

public final boolean isStartDocument()

Implements javax.xml.stream.events.XMLEvent.isStartDocument.

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

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

Returns:boolean: true if the event is StartDocument, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isStartDocument()

isStartElement back to summary

isStartElement	back to summary
public final boolean isStartElement() Implements javax.xml.stream.events.XMLEvent.isStartElement. Doc from javax.xml.stream.events.XMLEvent.isStartElement. A utility function to check if this event is a StartElement. Returns:boolean true if the event is `StartElement`, false otherwise See Also `javax.xml.stream.events.XMLEvent#isStartElement()`

public final boolean isStartElement()

Implements javax.xml.stream.events.XMLEvent.isStartElement.

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

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

Returns:boolean: true if the event is StartElement, false otherwise
See Also: javax.xml.stream.events.XMLEvent#isStartElement()

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object.

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

pack-priv abstract Class XMLEventImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail