xdoclet.modules.ejb.env
public class EnvTagsHandler extends XDocletTagSupport
Version: $Revision: 1.3 $
UNKNOWN: March 31, 2005 namespace = "EjbEnv"
Field Summary | |
---|---|
protected XMember | currentMember |
protected XTag | currentTag |
protected int | currentTagType |
Method Summary | |
---|---|
protected void | doGenerate(String template)
Called for each tag in the forTags loop. |
void | forAllMemberTags(String template, Properties attributes)
Executes the template for all method- and field-level tags with the passed name
|
void | forAllMethodTags(String template, Properties attributes)
Executes the template for all method-level tags with the passed name
|
void | forAllTags(String template, Properties attributes)
Executes the template for all class-, method- and field-level tags with the passed name
|
protected void | forTags(String template, Properties attributes, boolean forClass, boolean forMethod, boolean forField)
Executes the passed template for the passed
|
void | ifHasParam(String template, Properties attributes)
Executes the body only if the current tag has a specified parameter
|
void | ifHasTag(String template, Properties attributes)
Executes the body only if the current class has at least one ot the passed tags at field- or method-level
|
void | ifHasType(String template, Properties attributes)
Executes the body only if the current tag is either a method- or fiel-level tag or has a type parameter.
|
void | ifNotPrimitiveMember(String template, Properties attributes)
Executes the body only if the current field type or method return type is not a primitive.
|
void | ifParamValueEquals(String template, Properties attributes)
Executes the body only if the specified tag's value is equal to the specified value
|
void | ifParamValueNotEquals(String template, Properties attributes)
Executes the body only if the specified tag's value is equal to the specified value
|
void | ifPrimitiveMember(String template, Properties attributes)
Executes the body only if the current field type or method return type is primitive.
|
String | memberName(Properties attributes)
Returns the method or field name. |
String | memberType()
Returns the method's return type or the field's type. |
String | methodSignature()
Returns the method signature for the current method. |
String | name(Properties attributes)
Returns the name parameter value for the current tag. |
String | paramValue(Properties attributes)
Returns the value of a parameter.
|
String | type(Properties attributes)
Returns the type parameter value for the current tag. |
forTags
loop. The default behaviour is to call generate(template)
Parameters: template the template
Throws: XDocletException if an error occures
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "tagName" optional = "false" description = "the tag name" name = "paramName" optional = "true" description = "the required parameter" name = "paramValue" optional = "true" description = "the value for the required parameter" type = "block"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "tagName" optional = "false" description = "the tag name" name = "paramName" optional = "true" description = "the required parameter" name = "paramValue" optional = "true" description = "the value for the required parameter" type = "block"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "tagName" optional = "false" description = "the tag name" name = "paramName" optional = "true" description = "the required parameter" name = "paramValue" optional = "true" description = "the value for the required parameter" type = "block"
Parameters: template the template attributes the parameters forClass indicates whether the template should be excuted for class level tags forMethod indicates whether the template should be excuted for method level tags forField indicates whether the template should be excuted for field level tags
Throws: XDocletException if an error occures
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the parameter" type = "body"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "the tag names (comma separated)" name = "paramName" optional = "true" description = "tags must have this parameter" name = "paramValue" optional = "true" description = "tags must have this value for the * parameter with 'paramName'"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the name parameter" type = "block"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: type = "block"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the parameter" name = "value" optional = "false" description = "the value of the parameter" type = "body"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the parameter" name = "value" optional = "false" description = "the value of the parameter" type = "body"
Parameters: template the template attributes the attributes
Throws: XDocletException if an error occures
UNKNOWN: type = "block"
forAllMemberTags
or forAllMethodTags
.
Parameters: attributes the attributes
Returns: the memeber's name
Throws: XDocletException if an error occures
UNKNOWN: name = "prefix" optional = "true" description = "the prefix for the name" type = "content"
forAllMemberTags
or
forAllMethodTags
.
Returns: the member's type
Throws: XDocletException if an error occures
UNKNOWN: type = "content"
forAllMethodTags
.
Returns: the current method's signature
Throws: XDocletException if an error occures
UNKNOWN: type = "content"
Parameters: attributes the attributes
Returns: the name
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the name parameter" type = "content"
Parameters: attributes the attributes
Returns: the value
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the parameter" name = "values" description = "The valid values for the parameter, comma separated. An * error message is printed if the parameter value is not one of the values." name = "default" description = "The default value is returned if parameter not specified * by user for the tag." name = "mandatory" values = "true,false" description = "Generate an error if parameter not * type = "content"
Parameters: attributes the attributes
Returns: the type
Throws: XDocletException if an error occures
UNKNOWN: name = "paramName" optional = "false" description = "the name of the type parameter" name = "values" description = "The valid values for the parameter, comma separated. An * error message is printed if the parameter value is not one of the values." name = "default" description = "The default value is returned if parameter not specified * by user for the tag." name = "mandatory" values = "true,false" description = "Generate an error if parameter not * type = "content"