com.plumtree.portaluiinfrastructure.tags.metadata
Class TagMetaData

java.lang.Object
  com.plumtree.portaluiinfrastructure.tags.metadata.TagMetaData

All Implemented Interfaces:

ITagMetaData

public class TagMetaData
extends java.lang.Object
implements ITagMetaData

This class also enforces all lower case for the names of tags.

See Also:

com.plumtree.portaluiinfrastructure.tags.ITagMetaData

Field Summary

protected java.lang.String	m_strDescription
protected java.lang.String	m_strExample
protected java.lang.String	m_strName

Constructor Summary

TagMetaData(java.lang.String _strName, java.lang.String _strDescription)
This constructor takes the name and description of the tag.

TagMetaData(java.lang.String _strName, java.lang.String _strDescription, java.lang.String _strExample)
This constructor takes the name, description, and example text for this tag.

Method Summary

java.lang.String	GetDescription() Gets the description of the tag
java.lang.String	GetExample() Gets the example text for this tag
java.lang.String	GetName() Gets the name of the tag

Methods inherited from class java.lang.Object

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

Field Detail

m_strName

protected java.lang.String m_strName

m_strDescription

protected java.lang.String m_strDescription

m_strExample

protected java.lang.String m_strExample

Constructor Detail

TagMetaData

public TagMetaData(java.lang.String _strName,
                   java.lang.String _strDescription)

This constructor takes the name and description of the tag. It also converts the name to all lower case for standards compliance.

Parameters:

String - _strName The name of the tag

String - _strDescription The description of the tag

TagMetaData

public TagMetaData(java.lang.String _strName,
                   java.lang.String _strDescription,
                   java.lang.String _strExample)

This constructor takes the name, description, and example text for this tag. It also converts the name to all lower case for standards compliance.

Note that example text containing HTML must enclose it in an xml CDATA tag:
"example blah <![CDATA[<mylib:mytag attr1=\"foo\">]]> example"

Parameters:

String - _strName The name of the tag

String - _strDescription The description of the tag

String - _strExample The example text for the tag. Note that example text containing HTML formatting must be in xml CDATA format

Method Detail

GetName

public java.lang.String GetName()

Description copied from interface: ITagMetaData

Gets the name of the tag

Specified by:

GetName in interface ITagMetaData

Returns:

String The name of the tag

See Also:

com.plumtree.portaluiinfrastructure.tags.ITagMetaData#GetName()

GetDescription

public java.lang.String GetDescription()

Description copied from interface: ITagMetaData

Gets the description of the tag

Specified by:

GetDescription in interface ITagMetaData

Returns:

String The description of the tag

See Also:

com.plumtree.portaluiinfrastructure.tags.ITagMetaData#GetDescription()

GetExample

public java.lang.String GetExample()

Description copied from interface: ITagMetaData

Gets the example text for this tag

Note that example text containing HTML formatting must be in xml CDATA format

Specified by:

GetExample in interface ITagMetaData

Returns:

String The example for this tag

See Also:

com.plumtree.portaluiinfrastructure.tags.ITagMetaData#GetExample()