xdoclet.tagshandler
public class ParameterTagsHandler extends AbstractProgramElementTagsHandler
Version: $Revision: 1.19 $
UNKNOWN: Oct 15, 2001 namespace = "Parameter"
Field Summary | |
---|---|
protected static XParameter | currentMethodParameter
The current method's current parameter. forAllMethodParams sets the value while looping over the parameters of
current method.
|
protected static XTag | currentMethodParamTag
The currentMethodParamTag holds the current ParamTag corresponding to the current Parameter.
|
protected String | currentName |
Method Summary | |
---|---|
String | currentName()
return name of parameter currently being iterated - ugly hack...
|
void | forAllConstructorParams(String template)
Iterates over all parameters of current constructor and evaluates the body of the tag for each method.
|
void | forAllMethodParams(String template)
Iterates over all parameters of current method and evaluates the body of the tag for each method.
|
void | forAllParameterTypes(String template, Properties attributes)
Gets the value of the parameter specified by paramName of current tag, and assuming the value has the format of a
typical method definition extracts of parameter types out of it and evaluates the body for each parameter type.
current parameter type can be accessed as <XDtParameter:currentToken/>. |
static String | getMethodParamTypeFor(XParameter param) |
void | ifHasParams(String template, Properties attributes)
Evaluates the body of the tag if current method/constructor has parameters.
|
String | methodParamDescription()
The methodParamDescription method returns the comment text associated with the ParamTag for the
current Parameter
|
String | methodParamName()
Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration.
|
String | methodParamType(Properties attributes)
Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration. |
String | parameterList(Properties attributes)
Iterates over all parameters in current method and returns a string containing definition of all those
parameters.
|
See Also: ParameterTagsHandler
currentMethodParamTag
holds the current ParamTag corresponding to the current Parameter.
See Also: ParameterTagsHandler
Returns:
UNKNOWN: type = "content"
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block"
Parameters: template The body of the block tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block"
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "paramName" optional = "false" description = "The parameter name that its value is * used for extracting parameter types out of it."
Parameters: template The body of the block tag attributes
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "forConstructor" optional = "true" values = "true,false" description = "If true, then * look for parameters of current constructor instead of current method"
methodParamDescription
method returns the comment text associated with the ParamTag for the
current Parameter
Returns: a String
value
Throws: XDocletException if an error occurs
UNKNOWN: type = "content"
Returns: name of the current method parameter
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Parameters: attributes
Returns: Description of the Returned Value
Throws: XDocletException Description of Exception
UNKNOWN: type = "content"
Parameters: attributes The attributes of the template tag
Returns: Description of the Returned Value
Throws: XDocletException Description of Exception
UNKNOWN: type = "block" name = "includeDefinition" optional = "true" values = "true,false" description = "If true * then include the parameter type of parameters in the composed string." name = "forConstructor" optional = "true" values = "true,false" description = "If true, then * look for parameters of current constructor instead of current method"