com.tridion.tcdl

Class Tag

java.lang.Object

com.tridion.tcdl.Tag

public class Tag
extends Object

A tag as it is encountered in a TCDL document, consisting of the namespace, name and attributes.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTINUE_TAG_EVALUATION Continue tag evaluation.
static Tag	EMPTY_TAG Empty tag.
static int	SKIP_TAG Skip tag.

Constructor Summary

Constructors

Constructor and Description
Tag(String namespace, String name, Map<String,String> attributes) Constructs a Tag with given namespace, name and attributes.
Tag(String namespace, String name, Map<String,String> attributes, AttributeValueDelimiter attributeValueDelimiter) Constructs a Tag with given namespace, name and attributes.

Method Summary

Modifier and Type	Method and Description
String	getAttribute(String attributeName, String defaultValue) Get the value of an attribute, or the defaultValue if the attribute is not present.
Map<String,String>	getAttributes() All attributes for this tag, only present if the tag is (also) a start tag.
AttributeValueDelimiter	getAttributeValueDelimiter() Attribute delimiter of the tag.
Tag	getEnclosingTag() Returns enclosing Tag of this Tag, if present.
TagHandlerBase	getHandler() Returns the instance of associated TagHandlerBase, if available.
String	getName() Name of the tag without the namespace.
String	getNamespace() Namespace of the tag.
String	getQualifiedName() Returns the fully qualified name of this tag, that is namespace:name.
boolean	hasAttribute(String attributeName) Check if an attribute is present.
boolean	hasEnclosingTag() Returns a boolean value indicating whether current Tag instance has any enclosing Tag.
boolean	isSameNameSpace(Tag tag) Check if the namespace of a tag matches this tags namespace.
boolean	isSameTag(Tag tag) Check if the passed tag has the same name and namespace as this tag.
String	toString() Note, for debugging / displaying only, output format may change.

Methods inherited from class java.lang.Object

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

Field Detail

CONTINUE_TAG_EVALUATION

public static final int CONTINUE_TAG_EVALUATION

Continue tag evaluation.

See Also:

Constant Field Values

SKIP_TAG

public static final int SKIP_TAG

Skip tag.

See Also:

Constant Field Values

EMPTY_TAG

public static final Tag EMPTY_TAG

Empty tag.

Constructor Detail

Tag

public Tag(String namespace,
           String name,
           Map<String,String> attributes)

Constructs a Tag with given namespace, name and attributes.

Parameters:

namespace - name space in which the tag lives

name - name of this tag

attributes - attributes defined for the tag. May be null

Tag

public Tag(String namespace,
           String name,
           Map<String,String> attributes,
           AttributeValueDelimiter attributeValueDelimiter)

Constructs a Tag with given namespace, name and attributes.

Parameters:

namespace - name space in which the tag lives

name - name of this tag

attributes - attributes defined for the tag. May be null

attributeValueDelimiter - attributes delimiter for the tag. If null will be double quote.

Method Detail

getHandler

public TagHandlerBase getHandler()

Returns the instance of associated TagHandlerBase, if available. Otherwise it returns an instance of DefaultTagHandler, which is the default value.

Note that, this relationship between this Tagand its associated TagHandlerBase is established during transformation (processing or rendering) phase. Before that, invoking this method would return a DefaultTagHandler.

getEnclosingTag

public Tag getEnclosingTag()

Returns enclosing Tag of this Tag, if present.

Note that, this relationship between this Tag and its enclosing Tag is established during transformation (processing or rendering) phase.

If current Tag instance does not have any enclosing Tag, invoking this method throws IllegalStateException. Please use hasEnclosingTag() to figure out if current Tag has any enclosing Tag.

Returns:

enclosing Tag instance.

Throws:

IllegalStateException - if current Tag does not have any enclosing Tag.

hasEnclosingTag

public boolean hasEnclosingTag()

Returns a boolean value indicating whether current Tag instance has any enclosing Tag.

Returns:

true if it has, otherwise false.

getName

public String getName()

Name of the tag without the namespace.

Returns:

Name of the tag without the namespace

getNamespace

public String getNamespace()

Namespace of the tag.

Returns:

Namespace of the tag

getAttributeValueDelimiter

public AttributeValueDelimiter getAttributeValueDelimiter()

Attribute delimiter of the tag.

Returns:

Attribute delimiter of the tag

getAttributes

public Map<String,String> getAttributes()

All attributes for this tag, only present if the tag is (also) a start tag. Result can not be modified

Returns:

Attributes for this tag

getAttribute

public String getAttribute(String attributeName,
                           String defaultValue)

Get the value of an attribute, or the defaultValue if the attribute is not present.

Parameters:

attributeName - name of the attribute

defaultValue - value to return if the attribute has no value

Returns:

the value of an attribute, or the defaultValue if the attribute is not present

hasAttribute

public boolean hasAttribute(String attributeName)

Check if an attribute is present.

Parameters:

attributeName - name of the attribute

Returns:

true when the attribute is present

getQualifiedName

public String getQualifiedName()

Returns the fully qualified name of this tag, that is namespace:name.

Returns:

the fully qualified name of this tag

isSameTag

public boolean isSameTag(Tag tag)

Check if the passed tag has the same name and namespace as this tag.

Parameters:

tag - tag to check against

Returns:

true when name and namespace is the same as this tag

isSameNameSpace

public boolean isSameNameSpace(Tag tag)

Check if the namespace of a tag matches this tags namespace.

Parameters:

tag - tag to check against

Returns:

true when the tags namespace is the same as this tags

toString

public String toString()

Note, for debugging / displaying only, output format may change.

Overrides:

toString in class Object

Returns:

a string presentation of this Tag