xdoclet.modules.util
public class CollectionTagsHandler extends XDocletTagSupport
Version: $Revision: 1.2 $
UNKNOWN: 25 Jun 2002 namespace = "Collection"
Method Summary | |
---|---|
void | create(Properties attributes)
Creates a new utility collection that will store template data. |
void | destroy(Properties attributes)
Destroys the specified collection. |
String | get(Properties attributes)
Obtains one value contained in the collection. |
void | ifContains(String template, Properties attributes)
Generates the contained template code if the specified collection contains the key or value passed as attributes.
|
void | ifDoesntContain(String template, Properties attributes)
Generates the contained template code if the specified collection doesn't contain the key or value passed as
attributes. |
void | put(Properties attributes)
Puts a new element into the specified collection. |
void | remove(Properties attributes)
Removes an element from the specified collection. |
Parameters: attributes The attributes of the template tag
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content" name = "name" optional = "false" description = "The name for the newly created collection" name = "type" optional = "true" values = "map,set" description = "The type of the collection to * create. Default value is set"
Parameters: attributes The attributes of the tag template
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content" name = "name" description = "The collection to destroy."
Parameters: attributes The attributes of the template tag
Returns: The requested value or null if no such value exists.
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content" name = "key" optional = "false" description = "The collection to operate on." name = "name" optional = "false" description = "The key to retrive."
Parameters: template The block tag contents attributes The attributes of the tag template
Throws: XDocletException
UNKNOWN: type = "block" name = "name" optional = "false" description = "The collection to operate on." name = "key" optional = "true" description = "The key to check, if the collection is a * map." name = "value" optional = "true" description = "The valu to check, if the collection is a * set. If the collection is a map, the value to check for equality."
Parameters: template The block tag contents attributes The attributes of the tag template
Throws: XDocletException
UNKNOWN: type = "block" name = "name" optional = "false" description = "The collection to operate on." name = "key" optional = "true" description = "The key to check, if the collection is a * map." name = "value" optional = "true" description = "The valu to check, if the collection is a * set. If the collection is a map, the value to check for equality."
Parameters: attributes The attributes of the template tag
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content" name = "name" optional = "false" description = "The name of the collection to operate on. If * the collection does not exists, an execption will be thrown." name = "key" optional = "true" description = "The key to the new value. Should only be * specified if the collection is a map." name = "value" optional = "false" description = "The value to put into the collection."
Parameters: attributes The attributes of the template tag
Throws: XDocletException if something goes wrong
UNKNOWN: type = "content" name = "name" optional = "false" description = "The name of the collection to operate on. If * the collection does not exists, an execption will be thrown." name = "key" optional = "true" description = "The key to remove from the map. Invalid if the * collection is a set." name = "value" optional = "true" description = "The value to remove from the set. Invalid if * the collection is a map."