xdoclet.tags
Class ParameterTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.tags.AbstractProgramElementTagsHandler
                    |
                    +--xdoclet.tags.ParameterTagsHandler

public class ParameterTagsHandler

extends AbstractProgramElementTagsHandler

Version:

$Revision: 1.7 $

Author:

Ara Abrahamian (ara_e@email.com)

Field Summary

protected static com.sun.javadoc.Parameter	currentMethodParameter The current method's current parameter.
protected static com.sun.javadoc.ParamTag	currentMethodParamTag The currentMethodParamTag holds the current ParamTag corresponding to the current Parameter.

Fields inherited from class xdoclet.tags.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

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.
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() 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 exceptions thrown by the current method and returns a string containing definition of all those parameters.

Methods inherited from class xdoclet.tags.AbstractProgramElementTagsHandler

checkForWrap, currentToken, exceptionList, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getExecutableMemberDocForMemberName, getExecutableMemberDocForMemberName, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, hasExecutableMember, ifHasTag_Impl, ifTagValueEquals_Impl, matchValue, memberComment, setMatchValue, skipToken

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

currentMethodParameter

protected static com.sun.javadoc.Parameter currentMethodParameter

The current method's current parameter. forAllMethodParams sets the value while looping over the parameters of current method.

See Also:

forAllMethodParams(java.lang.String)

currentMethodParamTag

protected static com.sun.javadoc.ParamTag currentMethodParamTag

The currentMethodParamTag holds the current ParamTag corresponding to the current Parameter.

See Also:

forAllMethodParams(java.lang.String)

Constructor Detail

ParameterTagsHandler

public ParameterTagsHandler()

Method Detail

methodParamType

public java.lang.String methodParamType()
                                 throws XDocletException

Returns the type of the current method parameter, current method parameter is set inside a forAllMethodParams tag in each iteration.

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

methodParamDescription

public java.lang.String methodParamDescription()
                                        throws XDocletException

The methodParamDescription method returns the comment text associated with the ParamTag for the current Parameter

Returns:

a String value

Throws:

XDocletException - if an error occurs

methodParamName

public java.lang.String methodParamName()
                                 throws XDocletException

Returns the name of the current method parameter, current method parameter is set inside a forAllMethodParams tag in each iteration.

Returns:

name of the current method parameter

Throws:

XDocletException - Description of Exception

forAllMethodParams

public void forAllMethodParams(java.lang.String template)
                        throws XDocletException

Iterates over all parameters of current method and evaluates the body of the tag for each method.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

forAllConstructorParams

public void forAllConstructorParams(java.lang.String template)
                             throws XDocletException

Iterates over all parameters of current constructor and evaluates the body of the tag for each method.

Parameters:

template - The body of the block tag

Throws:

XDocletException - Description of Exception

parameterList

public java.lang.String parameterList(java.util.Properties attributes)
                               throws XDocletException

Iterates over all exceptions thrown by the current method and returns a string containing definition of all those parameters.

Parameters:

attributes - The attributes of the template tag

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

forAllParameterTypes

public void forAllParameterTypes(java.lang.String template,
                                 java.util.Properties attributes)
                          throws XDocletException

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.

Parameters:

attributes - The attributes of the template tag

template - The body of the block tag

Throws:

XDocletException - Description of Exception