org.apache.ecs.html
Class Comment

java.lang.Object
  |
  +--org.apache.ecs.GenericElement
        |
        +--org.apache.ecs.ElementAttributes
              |
              +--org.apache.ecs.ConcreteElement
                    |
                    +--org.apache.ecs.MultiPartElement
                          |
                          +--org.apache.ecs.html.Comment

All Implemented Interfaces:

Attributes, java.lang.Cloneable, Element, ElementRegistry, Printable, java.io.Serializable

public class Comment

extends MultiPartElement

implements Printable

This class defines a comment <-- VALUE --> Element.

Version:

$Id: Comment.java,v 1.8 2003/04/27 09:21:31 rdonkin Exp $

Author:

Stephan Nagy, Jon S. Stevens

See Also:

Serialized Form

Fields inherited from class org.apache.ecs.ConcreteElement

lineSeparator, registry, registryList

Fields inherited from class org.apache.ecs.ElementAttributes

attribute_equality_sign, attribute_filter, attribute_quote, attribute_quote_char, filter_attribute_state

Fields inherited from class org.apache.ecs.GenericElement

__text, _defaultFilter, begin_end_modifier, begin_end_modifier_defined, begin_start_modifier, begin_start_modifier_defined, case_type, codeset, element, element_type, end_element, end_end_modifier, end_end_modifier_defined, end_modifier_defined, end_start_modifier, end_start_modifier_defined, end_tag, filter, filter_state, position, pretty_print, start_modifier_defined, start_tag, tabLevel, VERSION

Fields inherited from interface org.apache.ecs.Attributes

NO_ATTRIBUTE_VALUE

Fields inherited from interface org.apache.ecs.Element

CENTER, LEFT, LOWERCASE, MIXEDCASE, RIGHT, UPPERCASE

Constructor Summary

Comment()
Default constructor use set* methods.

Comment(Element element)
Create a comment object containg this element.

Comment(java.lang.String element)
Create a comment object containg this element.

Method Summary

(package private) void	() private initializer.
Comment	addElement(Element element) Adds an Element to the element.
Comment	addElement(java.lang.String element) Adds an Element to the element.
Comment	addElement(java.lang.String hashcode, Element element) Adds an Element to the element.
Comment	addElement(java.lang.String hashcode, java.lang.String element) Adds an Element to the element.
java.lang.String	createEndTag()
java.lang.String	createStartTag() This method overrides createStartTag() in Generic Element.
Comment	removeElement(java.lang.String hashcode) Removes an Element from the element.

Methods inherited from class org.apache.ecs.ConcreteElement

addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, addElementToRegistry, clone, elements, getElement, isEmpty, keys, output, output, output, output, registryHasElement, registryHasElement, removeElementFromRegistry, removeElementFromRegistry

Methods inherited from class org.apache.ecs.ElementAttributes

addAttribute, addAttribute, addAttribute, addAttribute, attributes, getAttribute, getAttributeEqualitySign, getAttributeFilter, getAttributeFilterState, getAttributeQuote, getAttributeQuoteChar, hasAttribute, removeAttribute, setAttributeEqualitySign, setAttributeFilter, setAttributeFilterState, setAttributeQuote, setAttributeQuoteChar, setClass, setDir, setID, setLang, setStyle, setTitle

Methods inherited from class org.apache.ecs.GenericElement

alterCase, getBeginEndModifier, getBeginEndModifierDefined, getBeginStartModifier, getBeginStartModifierDefined, getCase, getCodeSet, getElementHashEntry, getElementType, getEndEndModifier, getEndEndModifierDefined, getEndStartModifier, getEndStartModifierDefined, getEndTagChar, getFilter, getFilterState, getNeedClosingTag, getNeedLineBreak, getPrettyPrint, getStartTagChar, getTabLevel, getTagPosition, getTagText, getVersion, putTabs, putTabs, removeBeginEndModifier, removeBeginStartModifier, removeEndEndModifier, removeEndStartModifier, setBeginEndModifier, setBeginEndModifierDefined, setBeginModifier, setBeginModifier, setBeginStartModifier, setBeginStartModifierDefined, setCase, setCodeSet, setElementType, setEndEndModifier, setEndEndModifierDefined, setEndModifier, setEndModifier, setEndStartModifier, setEndStartModifierDefined, setEndTagChar, setFilter, setFilterState, setNeedClosingTag, setPrettyPrint, setStartTagChar, setTabLevel, setTagPosition, setTagText, toString, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

Constructor Detail

Comment

public Comment()

Default constructor use set* methods.

Comment

public Comment(java.lang.String element)

Create a comment object containg this element.

Comment

public Comment(Element element)

Create a comment object containg this element.

Method Detail

void ()

private initializer.

Overrides:

in class MultiPartElement

addElement

public Comment addElement(java.lang.String hashcode,
                          Element element)

Adds an Element to the element.

Parameters:

hashcode - name of element for hash table

element - Adds an Element to the element.

addElement

public Comment addElement(java.lang.String hashcode,
                          java.lang.String element)

Adds an Element to the element.

Parameters:

hashcode - name of element for hash table

element - Adds an Element to the element.

addElement

public Comment addElement(Element element)

Adds an Element to the element.

Parameters:

element - Adds an Element to the element.

addElement

public Comment addElement(java.lang.String element)

Adds an Element to the element.

Parameters:

element - Adds an Element to the element.

removeElement

public Comment removeElement(java.lang.String hashcode)

Removes an Element from the element.

Parameters:

hashcode - the name of the element to be removed.

createStartTag

public java.lang.String createStartTag()

Description copied from class: ElementAttributes

This method overrides createStartTag() in Generic Element. It provides a way to print out the attributes of an element.

Overrides:

createStartTag in class ElementAttributes

createEndTag

public java.lang.String createEndTag()

Overrides:

createEndTag in class GenericElement