| javax.xml.stream.events.Characters |
Class Overview
This describes the interface to Characters events.
All text events get reported as Characters events.
Content, CData and whitespace are all reported as
Characters events. IgnorableWhitespace, in most cases,
will be set to false unless an element declaration of element
content is present for the current element.
Summary
| Public Methods |
|---|
|
abstract
String
|
getData()
Get the character data of this event
|
|
abstract
boolean
|
isCData()
Returns true if this is a CData section.
|
|
abstract
boolean
|
isIgnorableWhiteSpace()
Return true if this is ignorableWhiteSpace.
|
|
abstract
boolean
|
isWhiteSpace()
Returns true if this set of Characters
is all whitespace.
|
|
[Expand]
Inherited Methods |
|---|
From interface
javax.xml.stream.events.XMLEvent
|
abstract
Characters
|
asCharacters()
Returns this event as Characters, may result in
a class cast exception if this event is not Characters.
|
|
abstract
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.
|
|
abstract
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.
|
|
abstract
int
|
getEventType()
Returns an integer code for this event.
|
|
abstract
Location
|
getLocation()
Return the location of this event.
|
|
abstract
QName
|
getSchemaType()
This method is provided for implementations to provide
optional type information about the associated event.
|
|
abstract
boolean
|
isAttribute()
A utility function to check if this event is an Attribute.
|
|
abstract
boolean
|
isCharacters()
A utility function to check if this event is Characters.
|
|
abstract
boolean
|
isEndDocument()
A utility function to check if this event is an EndDocument.
|
|
abstract
boolean
|
isEndElement()
A utility function to check if this event is a EndElement.
|
|
abstract
boolean
|
isEntityReference()
A utility function to check if this event is an EntityReference.
|
|
abstract
boolean
|
isNamespace()
A utility function to check if this event is a Namespace.
|
|
abstract
boolean
|
isProcessingInstruction()
A utility function to check if this event is a ProcessingInstruction.
|
|
abstract
boolean
|
isStartDocument()
A utility function to check if this event is a StartDocument.
|
|
abstract
boolean
|
isStartElement()
A utility function to check if this event is a StartElement.
|
|
abstract
void
|
writeAsEncodedUnicode(Writer writer)
This method will write the XMLEvent as per the XML 1.0 specification as Unicode characters.
|
|
Public Methods
public
abstract
String
getData
()
Get the character data of this event
public
abstract
boolean
isCData
()
Returns true if this is a CData section. If this
event is CData its event type will be CDATA
If javax.xml.stream.isCoalescing is set to true CDATA Sections
that are surrounded by non CDATA characters will be reported
as a single Characters event. This method will return false
in this case.
public
abstract
boolean
isIgnorableWhiteSpace
()
Return true if this is ignorableWhiteSpace. If
this event is ignorableWhiteSpace its event type will
be SPACE.
public
abstract
boolean
isWhiteSpace
()
Returns true if this set of Characters
is all whitespace. Whitespace inside a document
is reported as CHARACTERS. This method allows
checking of CHARACTERS events to see if they
are composed of only whitespace characters