|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.tagshandler.AbstractProgramElementTagsHandler
xdoclet.tagshandler.ParameterTagsHandler
Field Summary | |
protected static xjavadoc.XParameter |
currentMethodParameter
The current method's current parameter. |
protected static xjavadoc.XTag |
currentMethodParamTag
The currentMethodParamTag holds the current ParamTag corresponding to the current Parameter. |
protected String |
currentName
|
Fields inherited from class xdoclet.tagshandler.AbstractProgramElementTagsHandler |
currentToken, matchPattern, tagTokenizer |
Fields inherited from class xdoclet.XDocletTagSupport |
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER |
Constructor Summary | |
ParameterTagsHandler()
|
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. |
static String |
getMethodParamTypeFor(xjavadoc.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. |
Methods inherited from class xdoclet.template.TemplateTagHandler |
getXJavaDoc, setXJavaDoc |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static xjavadoc.XParameter currentMethodParameter
forAllMethodParams(java.lang.String)
protected static xjavadoc.XTag currentMethodParamTag
currentMethodParamTag
holds the current ParamTag corresponding to the current Parameter.
forAllMethodParams(java.lang.String)
protected String currentName
Constructor Detail |
public ParameterTagsHandler()
Method Detail |
public static String getMethodParamTypeFor(xjavadoc.XParameter param)
public String methodParamType(Properties attributes) throws XDocletException
attributes
-
XDocletException
- Description of Exceptionpublic String methodParamDescription() throws XDocletException
methodParamDescription
method returns the comment text associated with the ParamTag for the
current Parameter
String
value
XDocletException
- if an error occurspublic String methodParamName() throws XDocletException
XDocletException
- Description of Exceptionpublic void forAllMethodParams(String template) throws XDocletException
template
- The body of the block tag
XDocletException
- Description of Exceptionpublic void forAllConstructorParams(String template) throws XDocletException
template
- The body of the block tag
XDocletException
- Description of Exceptionpublic void ifHasParams(String template, Properties attributes) throws XDocletException
template
- The body of the block tagattributes
-
XDocletException
- Description of Exceptionpublic String parameterList(Properties attributes) throws XDocletException
attributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic void forAllParameterTypes(String template, Properties attributes) throws XDocletException
attributes
- The attributes of the template tagtemplate
- The body of the block tag
XDocletException
- Description of Exceptionpublic String currentName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |