com.opensymphony.module.sitemesh.html

Class CustomTag

java.lang.Object

com.opensymphony.module.sitemesh.html.CustomTag

All Implemented Interfaces:

Tag

public class CustomTag
extends java.lang.Object
implements Tag

A CustomTag provides a mechanism to manipulate the contents of a Tag. The standard Tag implementations are immutable, however CustomTag allows a copy to be taken of an immutable Tag that can then be manipulated.

See Also:

Tag

Field Summary

Fields inherited from interface com.opensymphony.module.sitemesh.html.Tag

CLOSE, CLOSE_MAGIC_COMMENT, EMPTY, OPEN, OPEN_MAGIC_COMMENT

Constructor Summary

Constructors

Constructor and Description
CustomTag(java.lang.String name, int type) Type of tag: <blah> - Tag.OPEN </blah> - Tag.CLOSE <blah/> - Tag.EMPTY
CustomTag(Tag tag) Create a CustomTag based on an existing Tag - this takes a copy of the Tag.

Method Summary

Modifier and Type	Method and Description
int	addAttribute(java.lang.String name, java.lang.String value) Add a new attribute.
boolean	equals(java.lang.Object o)
int	getAttributeCount() Number of attributes in tag.
int	getAttributeIndex(java.lang.String name, boolean caseSensitive) Determine which attribute has the specified name.
java.lang.String	getAttributeName(int index) Get name of attribute.
java.lang.String	getAttributeValue(int index) Get value of an attribute.
java.lang.String	getAttributeValue(java.lang.String name, boolean caseSensitive) Get value of an attribute.
java.lang.String	getContents() Get the complete tag in its original form, preserving original formatting.
java.lang.String	getName() Name of tag (ie.
int	getType() Type of tag: <blah> - Tag.OPEN </blah> - Tag.CLOSE <blah/> - Tag.EMPTY
boolean	hasAttribute(java.lang.String name, boolean caseSensitive) Determine if an attribute is present.
int	hashCode()
void	removeAttribute(int attributeIndex) Remove an attribute.
void	removeAttribute(java.lang.String name, boolean caseSensitive) Change the value of an attribute, or add an attribute if it does not already exist.
void	setAttributeName(int attributeIndex, java.lang.String name) Change the name of an existing attribute.
void	setAttributeValue(int attributeIndex, java.lang.String value) Change the value of an existing attribute.
void	setAttributeValue(java.lang.String name, boolean caseSensitive, java.lang.String value) Change the value of an attribute, or add an attribute if it does not already exist.
void	setName(java.lang.String name) Change the name of the attribute.
void	setType(int type) Change the type of the tag.
java.lang.String	toString()
void	writeTo(CharArray out) Write out the complete tag in its original form, preserving original formatting.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomTag

public CustomTag(java.lang.String name,
                 int type)

Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

CustomTag

public CustomTag(Tag tag)

Create a CustomTag based on an existing Tag - this takes a copy of the Tag.

Method Detail

getContents

public java.lang.String getContents()

Description copied from interface: Tag

Get the complete tag in its original form, preserving original formatting. This has a slight overhead in that it needs to construct a String. For improved performance, use writeTo() instead.

Specified by:

getContents in interface Tag

See Also:

Tag.writeTo(com.opensymphony.module.sitemesh.html.util.CharArray)

writeTo

public void writeTo(CharArray out)

Description copied from interface: Tag

Write out the complete tag in its original form, preserving original formatting.

Specified by:

writeTo in interface Tag

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAttributeCount

public int getAttributeCount()

Description copied from interface: Tag

Number of attributes in tag.

Specified by:

getAttributeCount in interface Tag

getAttributeIndex

public int getAttributeIndex(java.lang.String name,
                             boolean caseSensitive)

Description copied from interface: Tag

Determine which attribute has the specified name.

Specified by:

getAttributeIndex in interface Tag

getAttributeName

public java.lang.String getAttributeName(int index)

Description copied from interface: Tag

Get name of attribute.

Specified by:

getAttributeName in interface Tag

getAttributeValue

public java.lang.String getAttributeValue(int index)

Description copied from interface: Tag

Get value of an attribute. If this is an empty attribute (i.e. just a name, without a value), null is returned.

Specified by:

getAttributeValue in interface Tag

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String name,
                                          boolean caseSensitive)

Description copied from interface: Tag

Get value of an attribute. If this is an empty attribute (i.e. just a name, without a value), null is returned.

Specified by:

getAttributeValue in interface Tag

hasAttribute

public boolean hasAttribute(java.lang.String name,
                            boolean caseSensitive)

Description copied from interface: Tag

Determine if an attribute is present.

Specified by:

hasAttribute in interface Tag

getName

public java.lang.String getName()

Description copied from interface: Tag

Name of tag (ie. element name).

Specified by:

getName in interface Tag

getType

public int getType()

Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

Specified by:

getType in interface Tag

setName

public void setName(java.lang.String name)

Change the name of the attribute.

setType

public void setType(int type)

Change the type of the tag. Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

addAttribute

public int addAttribute(java.lang.String name,
                        java.lang.String value)

Add a new attribute. This does not check for the existence of an attribute with the same name, thus allowing duplicate attributes.

Parameters:

name - Name of attribute to change.

value - New value of attribute or null for an HTML style empty attribute.

Returns:

Index of new attribute.

setAttributeValue

public void setAttributeValue(java.lang.String name,
                              boolean caseSensitive,
                              java.lang.String value)

Change the value of an attribute, or add an attribute if it does not already exist.

Parameters:

name - Name of attribute to change.

caseSensitive - Whether the name should be treated as case sensitive when searching for an existing value.

value - New value of attribute or null for an HTML style empty attribute.

setAttributeName

public void setAttributeName(int attributeIndex,
                             java.lang.String name)

Change the name of an existing attribute.

setAttributeValue

public void setAttributeValue(int attributeIndex,
                              java.lang.String value)

Change the value of an existing attribute. The value may be null for an HTML style empty attribute.

removeAttribute

public void removeAttribute(int attributeIndex)

Remove an attribute.

removeAttribute

public void removeAttribute(java.lang.String name,
                            boolean caseSensitive)

Change the value of an attribute, or add an attribute if it does not already exist.

Parameters:

name - Name of attribute to remove.

caseSensitive - Whether the name should be treated as case sensitive.