com.simonstl.moe.explicit
Class Comment

java.lang.Object
  |
  +--com.simonstl.moe.CoreComponent
        |
        +--com.simonstl.moe.explicit.Comment

All Implemented Interfaces:

AnnotableI, java.lang.Cloneable, CoreComponentI, NamingI

Direct Known Subclasses:

EndComment

public class Comment

extends CoreComponent

The Comment class provides a foundation for MOE objects to store comments. (Comments are not supported by the core SAX2 API.)

version 0.01 is the initial release and contains plenty of bogus placeholder functionality.

Version:

0.01 30 August 2001

Author:

Simon St.Laurent

Fields inherited from class com.simonstl.moe.CoreComponent

annotations, complete, componentType, content, context, name, parent, unorderedContent

Fields inherited from interface com.simonstl.moe.CoreComponentI

ATTRIBUTE, CDATA, CHARS, COMMENT, CONTAINER, DOCTYPE, DOCUMENT, ELEMENT, END_ATTRIBUTE, END_CDATA, END_COMMENT, END_CONTAINER, END_DOCTYPE, END_DOCUMENT, END_ELEMENT, END_NAMESPACE, END_PI, END_PROPERTY, GEN_ENTITY_END, GEN_ENTITY_REF, GEN_ENTITY_START, IG_WHITESPACE, NAMESPACE_DECL, PI, PROPERTY, UNPARSED, VALUE, XML_DECL

Constructor Summary

Comment()

Method Summary

java.lang.Object	clone() Clone implementation uses CoreComponent, adds text if necessary.
int	getBasicType() Comment objects have basic type COMMENT.
int	hashCode() The hashCode() method is the same as Characters, but as PI nodes generally have no nsURI or localName they'll all collide if stored in a set.
boolean	listen(CoreComponentI component) For now, the Comment class doesn't listen.
static void	main(java.lang.String[] args)
void	print() Prints a representation of the component to STDOUT
java.lang.String	toString() Returns a representation of the component as a String.
java.lang.String	toString(ComponentSetI namespaceContext) Returns a representation of the component as a String.

Methods inherited from class com.simonstl.moe.CoreComponent

add, addAll, addContent, addUnorderedContent, annotate, clearAll, clearContent, clearName, clearUnorderedContent, getAllAnnotations, getAnnotations, getContent, getIsComplete, getLocalName, getName, getNsURI, getParent, getPrefix, getQName, getTextContent, getTypes, getUnorderedContent, hasAnnotation, hasAnnotationOfType, hasAnnotations, removeAllAnnotations, removeAnnotation, setContent, setContent, setIsComplete, setLocalName, setName, setNsURI, setParent, setPrefix, setQName, setUnorderedContent, textComponent

Methods inherited from class java.lang.Object

equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Comment

public Comment()

Method Detail

hashCode

public int hashCode()

The hashCode() method is the same as Characters, but as PI nodes generally have no nsURI or localName they'll all collide if stored in a set. Processing Instructions must be stored in ordered content to work reliably. If you really want to store PIs in unordered content, override this.

Overrides:

hashCode in class CoreComponent

print

public void print()

Description copied from interface: CoreComponentI

Prints a representation of the component to STDOUT

Overrides:

print in class CoreComponent

toString

public java.lang.String toString()

Description copied from interface: CoreComponentI

Returns a representation of the component as a String. Note: toString() is really only guaranteed effective for debugging, because namespaces may require the additional intelligence of a visitor class.

Overrides:

toString in class CoreComponent

toString

public java.lang.String toString(ComponentSetI namespaceContext)

Description copied from interface: CoreComponentI

Returns a representation of the component as a String. Given a namespaceContext, this may be more effective than the regular toString().

getBasicType

public int getBasicType()

Comment objects have basic type COMMENT.

Overrides:

getBasicType in class CoreComponent

listen

public boolean listen(CoreComponentI component)

For now, the Comment class doesn't listen. I may revisit this decison later.

Overrides:

listen in class CoreComponent

clone

public java.lang.Object clone()

Clone implementation uses CoreComponent, adds text if necessary.

Overrides:

clone in class CoreComponent

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception