Class CommentEvent

java.lang.Object

com.bea.xml.stream.events.BaseEvent

com.bea.xml.stream.events.CharactersEvent

com.bea.xml.stream.events.CommentEvent

All Implemented Interfaces:

Characters, Comment, XMLEvent, Location, XMLStreamConstants

public class CommentEvent
extends CharactersEvent
implements Comment

Field Summary

Fields inherited from interface 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
CommentEvent()
CommentEvent(String data)

Method Summary

Modifier and Type	Method	Description
protected void	doWriteAsEncodedUnicode(Writer writer)	Template method to be implemented by sub-classes.
String	getText()	Return the string data of the comment, returns empty string if it does not exist
protected void	init()

Methods inherited from class CharactersEvent

getData, getDataAsArray, hasData, isCData, isIgnorableWhiteSpace, isWhiteSpace, setData, setIgnorable, setSpace

Methods inherited from class BaseEvent

asCharacters, asEndElement, asStartElement, getCharacterOffset, getColumnNumber, getEventType, getLineNumber, getLocation, getLocationURI, getPublicId, getSchemaType, getSourceName, getSystemId, getTypeAsString, isAttribute, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, recycle, setCharacterOffset, setColumnNumber, setEventType, setLineNumber, setLocationURI, toString, writeAsEncodedUnicode

Methods inherited from class Object

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

Methods inherited from interface XMLEvent

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

Constructor Details

CommentEvent

public CommentEvent()

CommentEvent

public CommentEvent(String data)

Method Details

init

protected void init()

Overrides:

init in class CharactersEvent

getText

public String getText()

Description copied from interface: javax.xml.stream.events.Comment

Return the string data of the comment, returns empty string if it does not exist

Specified by:

getText in interface Comment

doWriteAsEncodedUnicode

protected void doWriteAsEncodedUnicode(Writer writer)
                                throws IOException

Description copied from class: BaseEvent

Template method to be implemented by sub-classes.

Overrides:

doWriteAsEncodedUnicode in class CharactersEvent

Throws:

IOException