xdoclet.tagshandler
public class ParameterTagsHandler extends AbstractProgramElementTagsHandler
Modifier and Type | Field and Description |
---|---|
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 java.lang.String |
currentName |
currentToken, matchPattern, tagTokenizer
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
ParameterTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
currentName()
return name of parameter currently being iterated - ugly hack...
|
void |
forAllConstructorParams(java.lang.String template)
Iterates over all parameters of current constructor and evaluates the body of the tag for each method.
|
void |
forAllMethodParams(java.lang.String template)
Iterates over all parameters of current method and evaluates the body of the tag for each method.
|
void |
forAllParameterTypes(java.lang.String template,
java.util.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 java.lang.String |
getMethodParamTypeFor(xjavadoc.XParameter param) |
void |
ifHasParams(java.lang.String template,
java.util.Properties attributes)
Evaluates the body of the tag if current method/constructor has parameters.
|
java.lang.String |
methodParamDescription()
The
methodParamDescription method returns the comment text associated with the ParamTag for the
current Parameter |
java.lang.String |
methodParamName()
Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration.
|
java.lang.String |
methodParamType(java.util.Properties attributes)
Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag
in each iteration.
|
java.lang.String |
parameterList(java.util.Properties attributes)
Iterates over all parameters in current method and returns a string containing definition of all those
parameters.
|
checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember_OLD, hasExecutableMember, makeCopyOfArray, matchValue, memberComment, setMatchValue, skipToken
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
getXJavaDoc, setXJavaDoc
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 java.lang.String currentName
public static java.lang.String getMethodParamTypeFor(xjavadoc.XParameter param)
public java.lang.String methodParamType(java.util.Properties attributes) throws XDocletException
attributes
- XDocletException
- Description of Exceptionpublic java.lang.String methodParamDescription() throws XDocletException
methodParamDescription
method returns the comment text associated with the ParamTag for the
current ParameterString
valueXDocletException
- if an error occurspublic java.lang.String methodParamName() throws XDocletException
XDocletException
- Description of Exceptionpublic void forAllMethodParams(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- Description of Exceptionpublic void forAllConstructorParams(java.lang.String template) throws XDocletException
template
- The body of the block tagXDocletException
- Description of Exceptionpublic void ifHasParams(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- XDocletException
- Description of Exceptionpublic java.lang.String parameterList(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void forAllParameterTypes(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic java.lang.String currentName()