xdoclet.tagshandler

Class FieldTagsHandler

public class FieldTagsHandler extends AbstractProgramElementTagsHandler

Version: $Revision: 1.16 $

Author: Aslak Hellesxy

UNKNOWN: 13. januar 2002 namespace = "Field"

Method Summary
StringfieldComment(Properties attributes)
The comment for the current field.
StringfieldName()
Returns the name of the current field.
StringfieldTagValue(Properties attributes)
Iterates over all field tags with the specified tagName for the current field probably inside of a forAllFieldTags body.
StringfieldType()
Returns the type of the current field.
StringfirstSentenceDescriptionOfCurrentField()
Return standard javadoc of current field.
voidforAllFields(String template, Properties attributes)
Iterates over all fields of current class and evaluates the body of the tag for each field.
voidforAllFieldTags(String template, Properties attributes)
Iterates over all tags of current field and evaluates the body of the tag for each field.
voidforAllFieldTagTokens(String template, Properties attributes)
Iterates over all tokens in current field tag with the name tagName and evaluates the body for every token.
StringgetCapitalizedFieldName()
Returns the capitalized name of the current field.
static StringgetFieldTypeFor(XField field)
Gets the FieldTypeFor attribute of the FieldTagsHandler class
voidifDoesntHaveFieldTag(String template, Properties attributes)
Evaluates the body if current field doesnt have any tags with the specified name.
voidifFieldTagValueEquals(String template, Properties attributes)
Evaluates the body if value for the field tag equals the specified value.
voidifHasFieldTag(String template, Properties attributes)
Evaluates the body if current field has at least one tag with the specified name.
Stringmodifiers()
Describe what the method does

Method Detail

fieldComment

public String fieldComment(Properties attributes)
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: classComment

UNKNOWN: type = "content" name = "no-comment-signs" optional = "true" values = "true,false" description = "If true * then don't decorate the comment with comment signs." name = "indent" optional = "true" description = "Number of spaces to indent the comment. * Default is 0."

fieldName

public String fieldName()
Returns the name of the current field.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

fieldTagValue

public String fieldTagValue(Properties attributes)
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

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

fieldType

public String fieldType()
Returns the type of the current field.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

firstSentenceDescriptionOfCurrentField

public String firstSentenceDescriptionOfCurrentField()
Return standard javadoc of current field.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

forAllFields

public void forAllFields(String template, Properties attributes)
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

UNKNOWN: type = "block" name = "superclasses" optional = "true" values = "true,false" description = "If true then * traverse superclasses also, otherwise look up the tag in current concrete class only." name = "sort" optional = "true" values = "true,false" description = "If true then sort the * fields list."

forAllFieldTags

public void forAllFieldTags(String template, Properties attributes)
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

UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "superclasses" optional = "true" values = "true,false" description = "If true then * traverse superclasses also, otherwise look up the tag in current concrete class only. Default is true."

forAllFieldTagTokens

public void forAllFieldTagTokens(String template, Properties attributes)
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

UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "delimiter" description = "delimiter for the StringTokenizer. consult javadoc for * java.util.StringTokenizer default is ','" name = "skip" description = "how many tokens to skip on start"

getCapitalizedFieldName

public String getCapitalizedFieldName()
Returns the capitalized name of the current field.

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: type = "content"

getFieldTypeFor

public static String getFieldTypeFor(XField field)
Gets the FieldTypeFor attribute of the FieldTagsHandler class

Parameters: field Describe what the parameter does

Returns: The FieldTypeFor value

Throws: XDocletException Describe the exception

ifDoesntHaveFieldTag

public void ifDoesntHaveFieldTag(String template, Properties attributes)
Evaluates the body if current field doesnt have any tags with the specified name.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "error" description = "Show this error message if no tag found."

ifFieldTagValueEquals

public void ifFieldTagValueEquals(String template, Properties attributes)
Evaluates the body if value for the field tag equals the specified value.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "value" optional = "false" description = "The desired value."

ifHasFieldTag

public void ifHasFieldTag(String template, Properties attributes)
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

UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The tag name." name = "paramName" description = "The parameter name. If not specified, then the raw * content of the tag is returned." name = "paramNum" description = "The zero-based parameter number. It's used if the user * used the space-separated format for specifying parameters." name = "superclasses" optional = "true" values = "true,false" description = "If true then * traverse superclasses also, otherwise look up the tag in current concrete class only. Default is true." name = "error" description = "Show this error message if no tag found."

modifiers

public String modifiers()
Describe what the method does

Returns: Describe the return value

Throws: XDocletException Describe the exception