Package com.sun.xml.fastinfoset.stax.events

Class CharactersEvent

java.lang.Object

com.sun.xml.fastinfoset.stax.events.EventBase

com.sun.xml.fastinfoset.stax.events.CharactersEvent

All Implemented Interfaces:

javax.xml.stream.events.Characters, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

public class CharactersEvent
extends EventBase
implements javax.xml.stream.events.Characters

Field Summary

Fields inherited from class com.sun.xml.fastinfoset.stax.events.EventBase

_eventType, _location

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

Constructor Summary

Constructors

Constructor	Description
CharactersEvent()
CharactersEvent(java.lang.String data)
CharactersEvent(java.lang.String data, boolean isCData)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getData()	Get the character data of this event
boolean	isCData()
boolean	isIgnorableWhiteSpace()	Return true if this is ignorableWhiteSpace.
boolean	isWhiteSpace()	Returns true if this set of Characters are all whitespace.
void	setData(java.lang.String data)
void	setIgnorable(boolean isIgnorable)
void	setSpace(boolean isSpace)
java.lang.String	toString()

Methods inherited from class com.sun.xml.fastinfoset.stax.events.EventBase

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, getSystemId, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, setEventType, setLocation, writeAsEncodedUnicode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.stream.events.XMLEvent

asCharacters, asEndElement, asStartElement, getEventType, getLocation, getSchemaType, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, writeAsEncodedUnicode

Constructor Detail

CharactersEvent

public CharactersEvent()

CharactersEvent

public CharactersEvent(java.lang.String data)

Parameters:

data - Character Data.

CharactersEvent

public CharactersEvent(java.lang.String data,
                       boolean isCData)

Parameters:

data - Character Data.

isCData - true if is CData

Method Detail

getData

public java.lang.String getData()

Get the character data of this event

Specified by:

getData in interface javax.xml.stream.events.Characters

setData

public void setData(java.lang.String data)

isCData

public boolean isCData()

Specified by:

isCData in interface javax.xml.stream.events.Characters

Returns:

boolean returns true if the data is CData

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

String return the String representation of this event.

isIgnorableWhiteSpace

public boolean isIgnorableWhiteSpace()

Return true if this is ignorableWhiteSpace. If this event is ignorableWhiteSpace its event type will be SPACE.

Specified by:

isIgnorableWhiteSpace in interface javax.xml.stream.events.Characters

Returns:

boolean true if this is ignorableWhiteSpace.

isWhiteSpace

public boolean isWhiteSpace()

Returns true if this set of Characters are all whitespace. Whitspace inside a document is reported as CHARACTERS. This method allows checking of CHARACTERS events to see if they are composed of only whitespace characters

Specified by:

isWhiteSpace in interface javax.xml.stream.events.Characters

Returns:

boolean true if this set of Characters are all whitespace

setSpace

public void setSpace(boolean isSpace)

setIgnorable

public void setIgnorable(boolean isIgnorable)