cookxml.core.doclet
Interface DocletTagLibrary

All Superinterfaces:
TagLibrary
All Known Implementing Classes:
InheritableTagLibrary, SingleNSTagLibrary

public interface DocletTagLibrary
extends TagLibrary

This interface is used for tag libraries that are wish to carry the capability of being documented using CookXmlDoc.

Since:
CookXml 3.1
Version:
$Id: DocletTagLibrary.java 244 2007-06-07 04:29:13Z coconut $

Method Summary
 Map getAttributes(String ns, String tag)
          This function reports the attributes associated with a particular tag.
 Map getConverters(String ns)
          This function reports the converters associated with a namespace.
 String[] getNameSpaces()
          This function reports the namespaces this tag library holds.
 TagLibrary getParent()
          This function reports the parent tagLibrary.
 Map getTags()
          This function reports the tags having the creators and are located inside this tag library.
 
Methods inherited from interface cookxml.core.interfaces.TagLibrary
getAdder, getConverter, getCreator, getSetter, getSpecialCreator
 

Method Detail

getParent

TagLibrary getParent()
This function reports the parent tagLibrary.

Returns:
the parent TagLibrary.

getNameSpaces

String[] getNameSpaces()
This function reports the namespaces this tag library holds. It only reports *this* tag library's namespace, not parent tag library's.

Note that a namespace (a value inside the string array) can be null to indicate that the tag library does not handle namespaces.

Returns:
the namespaces this TagLibrary holds. It cannot be null and its size should be at least 1.

getTags

Map getTags()
This function reports the tags having the creators and are located inside this tag library.

The returned map uses XML namespace as the key, and a string array of tag names as the value as its entries.

Returns:
a map using XML namespace string as the key, and String[] as value for the tag names.

getAttributes

Map getAttributes(String ns,
                  String tag)
This function reports the attributes associated with a particular tag.

The returned map uses XML namespace as the key, and a string array of attribute names as the value as its entries.

Parameters:
ns - the namespace of the tag.
tag - the tag name.
Returns:
a map using XML namespace string as the key, and String[] as value for the tag names.

getConverters

Map getConverters(String ns)
This function reports the converters associated with a namespace.

Parameters:
ns - the namespace.
Returns:
a non-null array of converters for the specified namespace.