xdoclet.tags
Class FieldTagsHandler

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

public class FieldTagsHandler

extends AbstractProgramElementTagsHandler

Version:

$Revision: 1.8 $

Author:

Aslak Hellesøy

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

FieldTagsHandler()

Method Summary

java.lang.String	fieldComment(java.util.Properties attributes) The comment for the current field.
java.lang.String	fieldName() Returns the name of the current field.
java.lang.String	fieldTagValue(java.util.Properties attributes) Iterates over all field tags with the specified tagName for the current field probably inside of a forAllFieldTags body.
java.lang.String	fieldType() Returns the type of the current field.
void	forAllFields(java.lang.String template, java.util.Properties attributes) Iterates over all fields of current class and evaluates the body of the tag for each field.
void	forAllFieldTags(java.lang.String template, java.util.Properties attributes) Iterates over all tags of current field and evaluates the body of the tag for each field.
void	forAllFieldTagTokens(java.lang.String template, java.util.Properties attributes) Iterates over all tokens in current field tag with the name tagName and evaluates the body for every token.
static java.lang.String	getFieldTypeFor(com.sun.javadoc.FieldDoc field)
void	ifHasFieldTag(java.lang.String template, java.util.Properties attributes) Evaluates the body if current field has at least one tag with the specified name.

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

Constructor Detail

FieldTagsHandler

public FieldTagsHandler()

Method Detail

getFieldTypeFor

public static java.lang.String getFieldTypeFor(com.sun.javadoc.FieldDoc field)
                                        throws XDocletException

forAllFields

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

Iterates over all fields of current class and evaluates the body of the tag for each field.

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception

fieldName

public java.lang.String fieldName()
                           throws XDocletException

Returns the name of the current field.

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

fieldComment

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

The comment for the current field.

Parameters:

attributes - The attributes of the template tag

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

See Also:

ClassTagsHandler.classComment(java.util.Properties)

forAllFieldTags

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

Iterates over all tags of current field and evaluates the body of the tag for each field.

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception

forAllFieldTagTokens

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

Iterates over all tokens in current field tag with the name tagName and evaluates the body for every token.

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception

fieldTagValue

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

Iterates over all field tags with the specified tagName for the current field probably inside of a forAllFieldTags body.

Parameters:

attributes - The attributes of the template tag

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

fieldType

public java.lang.String fieldType()
                           throws XDocletException

Returns the type of the current field.

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

ifHasFieldTag

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

Evaluates the body if current field has at least one tag with the specified name.

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception