com.plumtree.portaluiinfrastructure.tags.metadata
Class TagLibraryMetaData

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

public class TagLibraryMetaData
extends java.lang.Object

This class provides programmatic access to the tag library meta data for name and description.

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

Field Summary

protected double	m_nVersion
protected java.lang.String	m_strDescription
protected java.lang.String	m_strDisplayName
protected java.lang.String	m_strLibraryName

Constructor Summary

TagLibraryMetaData(java.lang.String _strDisplayName, java.lang.String _strLibraryName, java.lang.String _strDescription, double _nVersion)
This constructor takes the name, description, and version of the tag.

Method Summary

boolean	Equals(java.lang.Object _object) Return true if the Object _object is a TagLibraryMetaData object and it's name and version are the same as this TagLibraryMetaData object's name and version.
java.lang.String	GetDescription() Gets the description of this tag library.
java.lang.String	GetDisplayName() Gets the display name of this tag library.
java.lang.String	GetName() Gets the name of this tag library.
double	GetVersion() Gets the version of this tag library.

Methods inherited from class java.lang.Object

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

Field Detail

m_strDisplayName

protected java.lang.String m_strDisplayName

m_strLibraryName

protected java.lang.String m_strLibraryName

m_strDescription

protected java.lang.String m_strDescription

m_nVersion

protected double m_nVersion

Constructor Detail

TagLibraryMetaData

public TagLibraryMetaData(java.lang.String _strDisplayName,
                          java.lang.String _strLibraryName,
                          java.lang.String _strDescription,
                          double _nVersion)

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

Parameters:

String - _strDisplayName The human readable name of this library for documentation purposes

String - _strLibraryName The library name for use in tags. This will be converted to lowercase

String - _strDescription The library description for documentation.

double - _nVersion The version of this library.

Method Detail

GetDisplayName

public java.lang.String GetDisplayName()

Gets the display name of this tag library.

This is the human readable name for documentation purposes, rather than the name used in tags.

E.G. "The Plumtree Core Tag Library"

Returns:

String The name of this tag library.

GetName

public java.lang.String GetName()

Gets the name of this tag library.

This is the name used to access a particular tag.

E.G. <pt:taglibraryname.tagname/>

Returns:

String The name of this tag library.

GetDescription

public java.lang.String GetDescription()

Gets the description of this tag library.

Returns:

String The description of this tag library.

GetVersion

public double GetVersion()

Gets the version of this tag library.

Returns:

double The version of this tag library

Equals

public boolean Equals(java.lang.Object _object)

Return true if the Object _object is a TagLibraryMetaData object and it's name and version are the same as this TagLibraryMetaData object's name and version. Otherwise return false.

Parameters:

_object - An object whose equality is being tested.

Returns:

true if the objects are equal, otherwise false.