Field

Implemented in class xdoclet.tagshandler.FieldTagsHandler.

Block Tags:

forAllFields (block template)

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

[superclasses] If true then traverse superclasses also, otherwise look up the tag in current concrete class only.

Valid Values = {true,false}
[sort] If true then sort the fields list.

Valid Values = {true,false}

forAllFieldTags (block template)

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

tagName The tag name.
[superclasses] If true then traverse superclasses also, otherwise look up the tag in current concrete class only. Default is true.

Valid Values = {true,false}

forAllFieldTagTokens (block template)

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

tagName The tag name.
[delimiter] delimiter for the StringTokenizer. consult javadoc for java.util.StringTokenizer default is ','
[skip] how many tokens to skip on start

ifHasFieldTag (block template)

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

tagName The tag name.
[paramName] The parameter name. If not specified, then the raw content of the tag is returned.
[paramNum] The zero-based parameter number. It's used if the user used the space-separated format for specifying parameters.
[superclasses] If true then traverse superclasses also, otherwise look up the tag in current concrete class only. Default is true.

Valid Values = {true,false}
[error] Show this error message if no tag found.

ifDoesntHaveFieldTag (block template)

Evaluates the body if current field doesnt have any tags with the specified name.

tagName The tag name.
[paramName] The parameter name. If not specified, then the raw content of the tag is returned.
[paramNum] The zero-based parameter number. It's used if the user used the space-separated format for specifying parameters.
[error] Show this error message if no tag found.

ifFieldTagValueEquals (block template)

Evaluates the body if value for the field tag equals the specified value.

tagName The tag name.
[paramName] The parameter name. If not specified, then the raw content of the tag is returned.
[paramNum] The zero-based parameter number. It's used if the user used the space-separated format for specifying parameters.
value The desired value.

setMatchValue (block template)

Sets the value of match variable.

value The new value for matchPattern.

Content templates:

getCapitalizedFieldName (content template)

Returns the capitalized name of the current field.

firstSentenceDescriptionOfCurrentField (content template)

Return standard javadoc of current field.

fieldName (content template)

Returns the name of the current field.

fieldComment (content template)

The comment for the current field.

[no-comment-signs] If true then don't decorate the comment with comment signs.

Valid Values = {true,false}
[indent] Number of spaces to indent the comment. Default is 0.

fieldTagValue (content template)

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

tagName The tag name.
[paramName] The parameter name. If not specified, then the raw content of the tag is returned.
[paramNum] The zero-based parameter number. It's used if the user used the space-separated format for specifying parameters.
[values] The valid values for the parameter, comma separated. An error message is printed if the parameter value is not one of the values.
[default] The default value is returned if parameter not specified by user for the tag.

fieldType (content template)

Returns the type of the current field.

matchValue (content template)

Returns the value of match variable. Match variable serves as a variable for templates, you set it somewhere in template and look it up somewhere else in template.

currentToken (content template)

Returns current token inside forAllClassTagTokens.

skipToken (content template)

Skips current token. Returns empty string.