cookxml.common
Class CommonLib

java.lang.Object
  cookxml.common.CommonLib

public class CommonLib

extends Object

Setup common component tags.

Since:

CookXml 1.0

Field Summary

static String	BASE
static String	LISTENERS
static String	MAP
static String	NAMESPACE this is the namespace for CookXml Common tags
static String	NOADD

Constructor Summary

CommonLib()

Method Summary

static InheritableTagLibrary	createTagLibrary(TagLibrary parentTagLibrary) Create a new instance of common tag library.
static InheritableTagLibrary	getSingletonTagLibrary() Get the singleton instance of the Common tag library.
static void	setupTags(InheritableTagLibrary tagLibrary) Setup common component tags for a tag library.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

this is the namespace for CookXml Common tags

See Also:

Constant Field Values

MAP

public static final String MAP

See Also:

Constant Field Values

LISTENERS

public static final String LISTENERS

See Also:

Constant Field Values

NOADD

public static final String NOADD

See Also:

Constant Field Values

BASE

public static final String BASE

See Also:

Constant Field Values

Constructor Detail

CommonLib

public CommonLib()

Method Detail

setupTags

public static void setupTags(InheritableTagLibrary tagLibrary)
                      throws CookXmlException

Setup common component tags for a tag library. Call this function only if you intend to setup tags manually.

Parameters:

tagLibrary - the tag library to be setup

Throws:

CookXmlException - thrown if errors occurred.

Since:

CookXml 1.0

createTagLibrary

public static InheritableTagLibrary createTagLibrary(TagLibrary parentTagLibrary)

Create a new instance of common tag library.

Parameters:

parentTagLibrary - the parent tag library

Returns:

the nwe instance of common tag library.

getSingletonTagLibrary

public static InheritableTagLibrary getSingletonTagLibrary()

Get the singleton instance of the Common tag library. Use this function if you want to conserve the memory in setting up multiple tag libraries that uses the common tag library.

This instance of library is not created until this functio is called.

Returns:

the global instance of the