fieldComment
public String fieldComment(Properties attributes)
throws XDocletException
The comment for the current field.
attributes
- The attributes of the template tag
- Description of the Returned Value
XDocletException
- Description of Exception
ClassTagsHandler.classComment(java.util.Properties)
- type = "content"
- name = "no-comment-signs"
optional = "true"
values = "true,false"
description = "If true
then don't decorate the comment with comment signs."
fieldName
public String fieldName()
throws XDocletException
Returns the name of the current field.
- Description of the Returned Value
XDocletException
- Description of Exception
- type = "content"
fieldTagValue
public String fieldTagValue(Properties attributes)
throws XDocletException
Iterates over all field tags with the specified tagName for the current field probably inside of a
forAllFieldTags body.
attributes
- The attributes of the template tag
- Description of the Returned Value
XDocletException
- Description of Exception
- 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()
throws XDocletException
Returns the type of the current field.
- Description of the Returned Value
XDocletException
- Description of Exception
- type = "content"
firstSentenceDescriptionOfCurrentField
public String firstSentenceDescriptionOfCurrentField()
throws XDocletException
Return standard javadoc of current field.
- Description of the Returned Value
XDocletException
- Description of Exception
- type = "content"
forAllFieldTagTokens
public void forAllFieldTagTokens(String template,
Properties attributes)
throws XDocletException
Iterates over all tokens in current field tag with the name tagName and evaluates the body for every token.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- 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"
forAllFieldTags
public void forAllFieldTags(String template,
Properties attributes)
throws XDocletException
Iterates over all tags of current field and evaluates the body of the tag for each field.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- 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."
forAllFields
public void forAllFields(String template,
Properties attributes)
throws XDocletException
Iterates over all fields of current class and evaluates the body of the tag for each field.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- 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."
getCapitalizedFieldName
public String getCapitalizedFieldName()
throws XDocletException
Returns the capitalized name of the current field.
- Description of the Returned Value
XDocletException
- Description of Exception
- type = "content"
getFieldTypeFor
public static String getFieldTypeFor(XField field)
throws XDocletException
Gets the FieldTypeFor attribute of the FieldTagsHandler class
field
- Describe what the parameter does
- The FieldTypeFor value
XDocletException
- Describe the exception
ifDoesntHaveFieldTag
public void ifDoesntHaveFieldTag(String template,
Properties attributes)
throws XDocletException
Evaluates the body if current field doesnt have any tags with the specified name.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- 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)
throws XDocletException
Evaluates the body if value for the field tag equals the specified value.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- 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)
throws XDocletException
Evaluates the body if current field has at least one tag with the specified name.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- 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."