APIdia Launch Partner
Top Description Fields Constructors Methods
com.sun.xml.internal.stream.events

public Class CommentEvent

extends DummyEvent
implements Comment
Class Inheritance
All Implemented Interfaces
javax.xml.stream.events.Comment, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants
Imports
javax.xml.stream.events.Comment, .XMLEvent

This class contains information about Comment event.
Author
Neeraj Bajaj, Sun Microsystems.

Field Summary

Modifier and TypeField and Description
private String
Inherited from com.sun.xml.internal.stream.events.DummyEvent:
fLocation

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

String
getText
()

Implements javax.xml.stream.events.Comment.getText.

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

protected void
init()

public String

Returns:

String String representation of this event
toString
()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

protected void
writeAsEncodedUnicodeEx(Writer writer)

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Inherited from com.sun.xml.internal.stream.events.DummyEvent:
asCharactersasEndElementasStartElementcharEncodegetEventTypegetLocationgetSchemaTypeisAttributeisCharacterDataisCharactersisEndDocumentisEndElementisEntityReferenceisNamespaceisProcessingInstructionisStartDocumentisStartElementsetEventTypesetLocationwriteAsEncodedUnicode

Field Detail

fTextback to summary
private String fText

Constructor Detail

CommentEventback to summary
public CommentEvent()
CommentEventback to summary
public CommentEvent(String text)

Method Detail

getTextback to summary
public String getText()

Implements javax.xml.stream.events.Comment.getText.

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

Returns:String

String

initback to summary
protected void init()
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

String String representation of this event

writeAsEncodedUnicodeExback to summary
protected void writeAsEncodedUnicodeEx(Writer writer) throws IOException

Implements abstract com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Doc from com.sun.xml.internal.stream.events.DummyEvent.writeAsEncodedUnicodeEx.

Helper method in order to expose IOException.

Exceptions
IOException:
if there is an IO error