|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.tagshandler.AbstractProgramElementTagsHandler
xdoclet.tagshandler.FieldTagsHandler
public class FieldTagsHandler
Field Summary |
---|
Fields inherited from class xdoclet.tagshandler.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. |
java.lang.String |
firstSentenceDescriptionOfCurrentField()
Return standard javadoc of 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. |
java.lang.String |
getCapitalizedFieldName()
Returns the capitalized name of the current field. |
static java.lang.String |
getFieldTypeFor(xjavadoc.XField field)
Gets the FieldTypeFor attribute of the FieldTagsHandler class |
void |
ifDoesntHaveFieldTag(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if current field doesnt have any tags with the specified name. |
void |
ifFieldTagValueEquals(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if value for the field tag equals the specified value. |
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. |
java.lang.String |
modifiers()
Describe what the method does |
Methods inherited from class xdoclet.template.TemplateTagHandler |
---|
getXJavaDoc, setXJavaDoc |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FieldTagsHandler()
Method Detail |
---|
public static java.lang.String getFieldTypeFor(xjavadoc.XField field) throws XDocletException
field
- Describe what the parameter does
XDocletException
- Describe the exceptionpublic java.lang.String getCapitalizedFieldName() throws XDocletException
XDocletException
- Description of Exceptionpublic void forAllFields(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic java.lang.String modifiers() throws XDocletException
XDocletException
- Describe the exceptionpublic java.lang.String firstSentenceDescriptionOfCurrentField() throws XDocletException
XDocletException
- Description of Exceptionpublic java.lang.String fieldName() throws XDocletException
XDocletException
- Description of Exceptionpublic java.lang.String fieldComment(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tag
XDocletException
- Description of ExceptionClassTagsHandler.classComment(java.util.Properties)
public void forAllFieldTags(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic void forAllFieldTagTokens(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic java.lang.String fieldTagValue(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic java.lang.String fieldType() throws XDocletException
XDocletException
- Description of Exceptionpublic void ifHasFieldTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic void ifDoesntHaveFieldTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exceptionpublic void ifFieldTagValueEquals(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |