|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface XMLEvent
This is the base event interface for handling markup events. Events are value objects that are used to communicate the XML 1.0 InfoSet to the Application. Events may be cached and referenced after the parse has completed.
XMLEventReader
,
Characters
,
ProcessingInstruction
,
StartElement
,
EndElement
,
StartDocument
,
EndDocument
,
EntityReference
,
EntityDeclaration
,
NotationDeclaration
Field Summary |
---|
Fields inherited from interface javax.xml.stream.XMLStreamConstants |
---|
ATTRIBUTE, CDATA, CHARACTERS, COMMENT, DTD, END_DOCUMENT, END_ELEMENT, ENTITY_DECLARATION, ENTITY_REFERENCE, NAMESPACE, NOTATION_DECLARATION, PROCESSING_INSTRUCTION, SPACE, START_DOCUMENT, START_ELEMENT |
Method Summary | |
---|---|
Characters |
asCharacters()
Returns this event as Characters, may result in a class cast exception if this event is not Characters. |
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. |
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. |
int |
getEventType()
Returns an integer code for this event. |
Location |
getLocation()
Return the location of this event. |
javax.xml.namespace.QName |
getSchemaType()
This method is provided for implementations to provide optional type information about the associated event. |
boolean |
isAttribute()
A utility function to check if this event is an Attribute. |
boolean |
isCharacters()
A utility function to check if this event is Characters. |
boolean |
isEndDocument()
A utility function to check if this event is an EndDocument. |
boolean |
isEndElement()
A utility function to check if this event is a EndElement. |
boolean |
isEntityReference()
A utility function to check if this event is an EntityReference. |
boolean |
isNamespace()
A utility function to check if this event is a Namespace. |
boolean |
isProcessingInstruction()
A utility function to check if this event is a ProcessingInstruction. |
boolean |
isStartDocument()
A utility function to check if this event is a StartDocument. |
boolean |
isStartElement()
A utility function to check if this event is a StartElement. |
void |
writeAsEncodedUnicode(java.io.Writer writer)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters. |
Method Detail |
---|
int getEventType()
XMLStreamConstants.START_ELEMENT
,
XMLStreamConstants.END_ELEMENT
,
XMLStreamConstants.CHARACTERS
,
XMLStreamConstants.ATTRIBUTE
,
XMLStreamConstants.NAMESPACE
,
XMLStreamConstants.PROCESSING_INSTRUCTION
,
XMLStreamConstants.COMMENT
,
XMLStreamConstants.START_DOCUMENT
,
XMLStreamConstants.END_DOCUMENT
,
XMLStreamConstants.DTD
Location getLocation()
Location
boolean isStartElement()
StartElement
boolean isAttribute()
Attribute
boolean isNamespace()
Namespace
boolean isEndElement()
EndElement
boolean isEntityReference()
EntityReference
boolean isProcessingInstruction()
ProcessingInstruction
boolean isCharacters()
Characters
boolean isStartDocument()
StartDocument
boolean isEndDocument()
EndDocument
StartElement asStartElement()
EndElement asEndElement()
Characters asCharacters()
javax.xml.namespace.QName getSchemaType()
void writeAsEncodedUnicode(java.io.Writer writer) throws XMLStreamException
writer
- The writer that will output the data
XMLStreamException
- if there is a fatal error writing the event
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |