com.sun.xml.stream.events
Class CommentEvent

java.lang.Object
  extended by com.sun.xml.stream.events.DummyEvent
      extended by com.sun.xml.stream.events.CommentEvent
All Implemented Interfaces:
javax.xml.stream.events.Comment, javax.xml.stream.events.XMLEvent, javax.xml.stream.XMLStreamConstants

public class CommentEvent
extends DummyEvent
implements javax.xml.stream.events.Comment

This class contains information about Comment event.

Author:
Neeraj Bajaj, Sun Microsystems.

Field Summary
 
Fields inherited from class com.sun.xml.stream.events.DummyEvent
fLocation
 
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
CommentEvent()
           
CommentEvent(java.lang.String text)
           
 
Method Summary
 java.lang.String getText()
          Return the string data of the comment, returns empty string if it does not exist
protected  void init()
           
 java.lang.String toString()
           
protected  void writeAsEncodedUnicodeEx(java.io.Writer writer)
          Helper method in order to expose IOException.
 
Methods inherited from class com.sun.xml.stream.events.DummyEvent
asCharacters, asEndElement, asStartElement, charEncode, getEventType, getLocation, getSchemaType, isAttribute, isCharacterData, isCharacters, isEndDocument, isEndElement, isEntityReference, isNamespace, isProcessingInstruction, isStartDocument, isStartElement, setEventType, 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

CommentEvent

public CommentEvent()

CommentEvent

public CommentEvent(java.lang.String text)
Method Detail

init

protected void init()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object
Returns:
String String representation of this event

getText

public java.lang.String getText()
Return the string data of the comment, returns empty string if it does not exist

Specified by:
getText in interface javax.xml.stream.events.Comment
Returns:
String

writeAsEncodedUnicodeEx

protected void writeAsEncodedUnicodeEx(java.io.Writer writer)
                                throws java.io.IOException
Description copied from class: DummyEvent
Helper method in order to expose IOException.

Specified by:
writeAsEncodedUnicodeEx in class DummyEvent
Parameters:
writer - The writer that will output the data
Throws:
java.io.IOException - if there is an IO error


Copyright ? 2002-2003 Apache XML Project. All Rights Reserved.