org.apache.ecs.xml
Class XML

java.lang.Object
  |
  +--org.apache.ecs.GenericElement
        |
        +--org.apache.ecs.ElementAttributes
              |
              +--org.apache.ecs.ConcreteElement
                    |
                    +--org.apache.ecs.MultiPartElement
                          |
                          +--org.apache.ecs.xml.XML

All Implemented Interfaces:

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

Direct Known Subclasses:

jsp_element, Return, VXMLElement

public class XML

extends MultiPartElement

implements Printable

This class creates a generic <> tag.

Version:

$Id: XML.java,v 1.4 2003/04/27 09:28:14 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

XML(java.lang.String element_type)
Default constructor use set* Methods.

XML(java.lang.String element_type, boolean close)
Construct a new XML element with this name,
and specify if it needs the element tag closed.

XML(java.lang.String element_type, boolean close, boolean filter)
Construct a new XML element with this name, and specify a filter for it.

XML(java.lang.String element_type, boolean close, Filter filter)
Construct a new XML element with this name, and specify a filter for it.

XML(java.lang.String element_type, Filter filter)
Construct a new XML element with this name, and specify a filter for it.

Method Summary

XML	addElement(Element element) Add an element to the valuie of <>VALUE</>
XML	addElement(java.lang.String element) Add an element to the valuie of <>VALUE</>
XML	addElement(java.lang.String hashcode, Element element) Adds an Element to the element.
XML	addElement(java.lang.String hashcode, java.lang.String element) Adds an Element to the element.
XML	addXMLAttribute(java.lang.String attribute, java.lang.String attribute_value) Add a new attribute to this XML tag.
char	getBeginEndModifier() What is the element modifier for this tag.
boolean	getBeginEndModifierDefined() Modifier optimization
boolean	getNeedLineBreak() Determine if this element needs a line break, if pretty printing.
XML	removeElement(java.lang.String hashcode) Removes an Element from the element.

Methods inherited from class org.apache.ecs.MultiPartElement

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, createStartTag, 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, createEndTag, getBeginStartModifier, getBeginStartModifierDefined, getCase, getCodeSet, getElementHashEntry, getElementType, getEndEndModifier, getEndEndModifierDefined, getEndStartModifier, getEndStartModifierDefined, getEndTagChar, getFilter, getFilterState, getNeedClosingTag, 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

XML

public XML(java.lang.String element_type)

Default constructor use set* Methods. With this name.

Parameters:

element_type - The name of this element.

XML

public XML(java.lang.String element_type,
           boolean close)

Construct a new XML element with this name,
and specify if it needs the element tag closed.

Parameters:

element_type - The name of this element.

close - Should it have a closing tag

XML

public XML(java.lang.String element_type,
           Filter filter)

Construct a new XML element with this name, and specify a filter for it.

Parameters:

element_type - The name of this element.

filter - a new Filter for this element override the default.

XML

public XML(java.lang.String element_type,
           boolean close,
           boolean filter)

Construct a new XML element with this name, and specify a filter for it.

Parameters:

element_type - The name of this element.

close - Should it have a closing tag

filter - Should this element be filtered?

XML

public XML(java.lang.String element_type,
           boolean close,
           Filter filter)

Construct a new XML element with this name, and specify a filter for it.

Parameters:

element_type - The name of this element.

close - Should it have a closing tag

filter - a new Filter for this element override the default.

Method Detail

addXMLAttribute

public XML addXMLAttribute(java.lang.String attribute,
                           java.lang.String attribute_value)

Add a new attribute to this XML tag.

Parameters:

attribute - the attribute name

attribute_value - the value of the attribute set this to
"ECS_NO_ATTRIBUTE_VALUE" if this attribute
doesn't take a value.

addElement

public XML addElement(java.lang.String element)

Add an element to the valuie of <>VALUE</>

Parameters:

element - the value of <>VALUE</>

addElement

public XML 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 XML 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 XML addElement(Element element)

Add an element to the valuie of <>VALUE</>

Parameters:

element - the value of <>VALUE</>

removeElement

public XML removeElement(java.lang.String hashcode)

Removes an Element from the element.

Parameters:

hashcode - the name of the element to be removed.

getNeedLineBreak

public boolean getNeedLineBreak()

Description copied from class: GenericElement

Determine if this element needs a line break, if pretty printing.

Overrides:

getNeedLineBreak in class GenericElement

getBeginEndModifierDefined

public boolean getBeginEndModifierDefined()

Description copied from class: GenericElement

Modifier optimization

Overrides:

getBeginEndModifierDefined in class GenericElement

getBeginEndModifier

public char getBeginEndModifier()

Description copied from class: GenericElement

What is the element modifier for this tag.

Overrides:

getBeginEndModifier in class GenericElement