This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.xml.stream.events
interface Characters
- All Superinterfaces:
- XMLEvent, XMLStreamConstants
public interface Characters
extends XMLEvent
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.
Fields inherited from class 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 |
String |
Get the character data of this event
|
boolean |
Returns true if this is a CData section.
|
boolean |
Return true if this is ignorableWhiteSpace.
|
boolean |
Returns true if this set of Characters
is all whitespace.
|
Methods inherited from class javax.xml.stream.events.XMLEvent |
asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode |
getData
public String getData()
-
Get the character data of this event
isCData
public 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.
isIgnorableWhiteSpace
public boolean isIgnorableWhiteSpace()
-
Return true if this is ignorableWhiteSpace. If
this event is ignorableWhiteSpace its event type will
be SPACE.
isWhiteSpace
public 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
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.