com.simonstl.moe.explicit
Class Characters

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

All Implemented Interfaces:

AnnotableI, java.lang.Cloneable, CoreComponentI, NamingI

Direct Known Subclasses:

ProcInst, Whitespace

public class Characters

extends CoreComponent

The Characters class provides a foundation for MOE objects to store text.

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

Version:

0.01 25 August 2001

Author:

Simon St.Laurent

Field Summary

protected java.lang.String

textContent

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

Characters()

Method Summary

void	addContent(CoreComponentI newComponent) Adds content to this component.
void	clearContent() Clears the content for this component.
java.lang.Object	clone() Clone implementation uses CoreComponent, adds text if necessary.
int	getBasicType() The basic type for Characters is CHARS.
ComponentListI	getContent() Returns the content for this component as a list of nodes.
java.lang.String	getTextContent() Returns the content for this component as a string.
int	hashCode() The hashCode() method is the same as CoreComponent's, but as character nodes generally have no nsURI or localName they'll all collide if stored in a set.
boolean	listen(CoreComponentI component) For now, the Characters class passes listening to its superclass.
static void	main(java.lang.String[] args)
void	print() Prints a representation of the component to STDOUT
void	setContent(ComponentList _content)
void	setContent(java.lang.String _content) Sets the content for this component as a string.
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, addUnorderedContent, annotate, clearAll, clearName, clearUnorderedContent, getAllAnnotations, getAnnotations, getIsComplete, getLocalName, getName, getNsURI, getParent, getPrefix, getQName, getTypes, getUnorderedContent, hasAnnotation, hasAnnotationOfType, hasAnnotations, removeAllAnnotations, removeAnnotation, 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

Field Detail

textContent

protected java.lang.String textContent

Constructor Detail

Characters

public Characters()

Method Detail

hashCode

public int hashCode()

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

Overrides:

hashCode in class CoreComponent

setContent

public void setContent(java.lang.String _content)

Description copied from interface: CoreComponentI

Sets the content for this component as a string.

Overrides:

setContent in class CoreComponent

setContent

public void setContent(ComponentList _content)

addContent

public void addContent(CoreComponentI newComponent)

Description copied from interface: CoreComponentI

Adds content to this component.

Overrides:

addContent in class CoreComponent

clearContent

public void clearContent()

Description copied from interface: CoreComponentI

Clears the content for this component.

Overrides:

clearContent in class CoreComponent

getTextContent

public java.lang.String getTextContent()

Description copied from interface: CoreComponentI

Returns the content for this component as a string.

Overrides:

getTextContent in class CoreComponent

getContent

public ComponentListI getContent()

Description copied from interface: CoreComponentI

Returns the content for this component as a list of nodes.

Overrides:

getContent 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()

The basic type for Characters is CHARS.

Overrides:

getBasicType in class CoreComponent

listen

public boolean listen(CoreComponentI component)
               throws MOEException

For now, the Characters class passes listening to its superclass.

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