|
|||||||||||
| 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
| 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 | |
String |
fieldComment(Properties attributes)
The comment for the current field. |
String |
fieldName()
Returns the name of the current field. |
String |
fieldTagValue(Properties attributes)
Iterates over all field tags with the specified tagName for the current field probably inside of a forAllFieldTags body. |
String |
fieldType()
Returns the type of the current field. |
String |
firstSentenceDescriptionOfCurrentField()
Return standard javadoc of current field. |
void |
forAllFields(String template,
Properties attributes)
Iterates over all fields of current class and evaluates the body of the tag for each field. |
void |
forAllFieldTags(String template,
Properties attributes)
Iterates over all tags of current field and evaluates the body of the tag for each field. |
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. |
static String |
getFieldTypeFor(xjavadoc.XField field)
Gets the FieldTypeFor attribute of the FieldTagsHandler class |
void |
ifFieldTagValueEquals(String template,
Properties attributes)
Evaluates the body if value for the field tag equals the specified value. |
void |
ifHasFieldTag(String template,
Properties attributes)
Evaluates the body if current field has at least one tag with the specified name. |
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 String getFieldTypeFor(xjavadoc.XField field)
throws XDocletException
field - Describe what the parameter does
XDocletException - Describe the exception
public void forAllFields(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public String modifiers()
throws XDocletException
XDocletException - Describe the exception
public String firstSentenceDescriptionOfCurrentField()
throws XDocletException
XDocletException - Description of Exception
public String fieldName()
throws XDocletException
XDocletException - Description of Exception
public String fieldComment(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of ExceptionClassTagsHandler.classComment(java.util.Properties)
public void forAllFieldTags(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void forAllFieldTagTokens(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public String fieldTagValue(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public String fieldType()
throws XDocletException
XDocletException - Description of Exception
public void ifHasFieldTag(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
public void ifFieldTagValueEquals(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes - The attributes of the template tag
XDocletException - Description of Exception
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||