XMLEvent (Java EE 5 SDK)

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.

版本:: 1.0
作者:: Copyright (c) 2003 by BEA Systems. All Rights Reserved.
另请参见:: XMLEventReader, Characters, ProcessingInstruction, StartElement, EndElement, StartDocument, EndDocument, EntityReference, EntityDeclaration, NotationDeclaration

字段摘要

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`

方法摘要
`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.
`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(Writer writer)` This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.

方法详细信息

getEventType

int getEventType()

Returns an integer code for this event.

另请参见:: 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

getLocation

Location getLocation()

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

另请参见:: Location

isStartElement

boolean isStartElement()

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

另请参见:: StartElement

isAttribute

boolean isAttribute()

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

另请参见:: Attribute

isNamespace

boolean isNamespace()

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

另请参见:: Namespace

isEndElement

boolean isEndElement()

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

另请参见:: EndElement

isEntityReference

boolean isEntityReference()

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

另请参见:: EntityReference

isProcessingInstruction

boolean isProcessingInstruction()

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

另请参见:: ProcessingInstruction

isCharacters

boolean isCharacters()

A utility function to check if this event is Characters.

另请参见:: Characters

isStartDocument

boolean isStartDocument()

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

另请参见:: StartDocument

isEndDocument

boolean isEndDocument()

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

另请参见:: EndDocument

asStartElement

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.

asEndElement

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.

asCharacters

Characters asCharacters()

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

getSchemaType

QName 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.

writeAsEncodedUnicode

void writeAsEncodedUnicode(Writer writer)
                           throws XMLStreamException

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.

参数:: writer - The writer that will output the data
抛出异常:: XMLStreamException - if there is a fatal error writing the event

概述

软件包

类

树

已过时

索引

帮助

Java EE 5 SDK

深圳电信培训中心.徐海蛟老师.

上一个类 下一个 CLASS

框架 无框架

摘要: 嵌套 | 字段 | 构造器 | 方法

详细信息: 字段 | 构造器 | 方法

提交错误或意见

previous page start next page