Package eu.bandm.tools.tdom.runtime

Class TypedComment

java.lang.Object

eu.bandm.tools.tdom.runtime.TypedNode

eu.bandm.tools.tdom.runtime.TypedEthereal

eu.bandm.tools.tdom.runtime.TypedComment

public class TypedComment
extends TypedEthereal

Realizes comments in a tdom model instance.

Nested Class Summary

Nested classes/interfaces inherited from class eu.bandm.tools.tdom.runtime.TypedNode

TypedNode.ParseListener<E extends TypedElement<?,?>>

Constructor Summary

Constructors

Constructor	Description
TypedComment()	Comment with empty contents.
TypedComment(String text)	Comment with contents.

Method Summary

Modifier and Type	Method	Description
static String	detox(String c)	Prepares the text for a comment by eliminating the forbidden sequence "--".
void	dump(ContentHandler contentHandler, LexicalHandler lexicalHandler)	Write this model component to a SAX output stream.
void	encode(EncodingOutputStream out, TypedExtension ext)	Abstract fall-back method which MUST be overridden and always throws an Exception.
String	getText()	Returns the text contents.
void	setText(String text)	set the text contents.

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedEthereal

forAnyExtension

Methods inherited from class eu.bandm.tools.tdom.runtime.TypedNode

asBigDecimal, asBigDecimal, asBigDecimal, asBigDecimal, asBigInteger, asBigInteger, asBigInteger, asBigInteger, asBoolean, asBoolean, asDouble, asDouble, asDouble, asDouble, asFloat, asFloat, asFloat, asFloat, asHexInt, asHexInt, asHexInt, asHexInt, asInt, asInt, asInt, asInt, asLong, asLong, asLong, asLong, asTrimmedString, asTrimmedString, asTrimmedString, asTrimmedString, checkPlus, checkPlus, checkStar, checkStar, checkStrict, encode, encodeOptional, encodePlus, encodePlus, encodeStar, encodeStar, extractEthereals, getLocation, getPCData, setLocation, setLocation, setLocation

Methods inherited from class java.lang.Object

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

Constructor Details

TypedComment

public TypedComment(String text)

Comment with contents.

Throws:

IllegalArgumentException - in case of text==null

TypedComment

public TypedComment()

Comment with empty contents.

Method Details

getText

public String getText()

Returns the text contents.

Returns:

the text contents.

setText

public void setText(String text)

set the text contents.

Throws:

IllegalArgumentException - in case of text==null

encode

public void encode(EncodingOutputStream out,
 TypedExtension ext)
            throws IOException

Description copied from class: TypedNode

Abstract fall-back method which MUST be overridden and always throws an Exception.

Specified by:

encode in class TypedNode

Throws:

IOException

dump

public void dump(ContentHandler contentHandler,
 @Opt
 LexicalHandler lexicalHandler)
          throws SAXException

Write this model component to a SAX output stream. Please note that in the SAX architecture, PIs are treated by a ContentHandler, but Comments by a LexicalHandler, so these two handlers must be supplied as a tandem for a method defined with this abstract class.

Specified by:

dump in class TypedEthereal

Parameters:

contentHandler - (never null) SAX handler for writing a TypedProcessingInstruction

lexicalHandler - SAX handler for writing a Comment. If null, then the comments are silently discarded.

Throws:

SAXException

detox

public static String detox(String c)

Prepares the text for a comment by eliminating the forbidden sequence "--". The second "minus" will be replaced by a "maplet".