XMLEvent JDK 1.6)

Description

public interface XMLEvent

This is the base event interface for handling markup events.

See also: XMLEventReader Characters ProcessingInstruction StartElement EndElement StartDocument EndDocument EntityReference EntityDeclaration NotationDeclaration

Methods

Hide/Show inherited methods

public Characters asCharacters ()

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

public EndElement 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 StartElement 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 int getEventType ()

Returns an integer code for this event.

public Location getLocation ()

Return the location of this event.

public QName getSchemaType ()

This method is provided for implementations to provide optional type information about the associated event.

public boolean isAttribute ()

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

public boolean isCharacters ()

A utility function to check if this event is Characters.

public boolean isEndDocument ()

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

public boolean isEndElement ()

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

public boolean isEntityReference ()

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

public boolean isNamespace ()

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

public boolean isProcessingInstruction ()

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

public boolean isStartDocument ()

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

public boolean isStartElement ()

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

public void writeAsEncodedUnicode (Writer writer) throws XMLStreamException

This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.

Fields

Hide/Show inherited fields

publicfinalstatic int ATTRIBUTE = "10" [Inherited From XMLStreamConstants]

Indicates an event is an attribute

publicfinalstatic int CDATA = "12" [Inherited From XMLStreamConstants]

Indicates an event is a CDATA section

publicfinalstatic int CHARACTERS = "4" [Inherited From XMLStreamConstants]

Indicates an event is characters

publicfinalstatic int COMMENT = "5" [Inherited From XMLStreamConstants]

Indicates an event is a comment

publicfinalstatic int DTD = "11" [Inherited From XMLStreamConstants]

Indicates an event is a DTD

publicfinalstatic int END_DOCUMENT = "8" [Inherited From XMLStreamConstants]

Indicates an event is an end document

publicfinalstatic int END_ELEMENT = "2" [Inherited From XMLStreamConstants]

Indicates an event is an end element

publicfinalstatic int ENTITY_DECLARATION = "15" [Inherited From XMLStreamConstants]

Indicates a Entity Declaration

publicfinalstatic int ENTITY_REFERENCE = "9" [Inherited From XMLStreamConstants]

Indicates an event is an entity reference

publicfinalstatic int NAMESPACE = "13" [Inherited From XMLStreamConstants]

Indicates the event is a namespace declaration

publicfinalstatic int NOTATION_DECLARATION = "14" [Inherited From XMLStreamConstants]

Indicates a Notation

publicfinalstatic int PROCESSING_INSTRUCTION = "3" [Inherited From XMLStreamConstants]

Indicates an event is a processing instruction

publicfinalstatic int SPACE = "6" [Inherited From XMLStreamConstants]

The characters are white space (see [XML], 2.10 "White Space Handling").

publicfinalstatic int START_DOCUMENT = "7" [Inherited From XMLStreamConstants]

Indicates an event is a start document

publicfinalstatic int START_ELEMENT = "1" [Inherited From XMLStreamConstants]

Indicates an event is a start element