|
|||||||||||
| 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.PropertyTagsHandler
PropertyTagsHandler.java
| 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 | |
PropertyTagsHandler()
|
|
| Method Summary | |
void |
forAllPropertiesWithTag(String template,
Properties attributes)
Evaluates the body block for each property of current mbean.You may set whether superclasses are examined also with the superclass attribute. |
static xjavadoc.XMethod |
getXMethodForMethodName(String methodName)
Searches for the XMethod of the method with name methodName and returns it. |
static xjavadoc.XMethod |
getXMethodForMethodName(String methodName,
boolean superclasses)
|
void |
ifHasGetMethodWithTag(String template,
Properties attributes)
The block tag ifHasGetMethodWithTag looks for a get method based on the attribute name from the
current method, sets the current method to that get method, and applies the template if found. |
void |
ifHasParamWithTag(String template,
Properties attributes)
Determines if there is a get or set method with the required tag for the current property that also has the requested parameter. |
void |
ifHasSetMethodWithTag(String template,
Properties attributes)
The block tag ifHasSetMethodWithTag looks for a set method based on the attribute name from the
current method, sets the current method to that set method, and applies the template if found. |
String |
paramValueWithTag(Properties attributes)
Looks for a get or set method with the required tag for the current property that also has the requested parameter, and returns the value of the requested parameter if present. |
String |
propertyTypeWithTag(Properties attributes)
The propertyTypeWithTag method figures out the type for the current property with tag by looking for
a getter, then a setter. |
| 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 PropertyTagsHandler()
| Method Detail |
public static xjavadoc.XMethod getXMethodForMethodName(String methodName)
methodName - Description of Parameter
public static xjavadoc.XMethod getXMethodForMethodName(String methodName,
boolean superclasses)
public void forAllPropertiesWithTag(String template,
Properties attributes)
throws XDocletException
template - The body of the block tagattributes -
XDocletException - Description of Exception
public void ifHasGetMethodWithTag(String template,
Properties attributes)
throws XDocletException
ifHasGetMethodWithTag looks for a get method based on the attribute name from the
current method, sets the current method to that get method, and applies the template if found. This is used to
look for getters for mbean managed attributes. The get method found may be the current method.
template - a String valueattributes - a Properties value
XDocletException - if an error occurs
public void ifHasSetMethodWithTag(String template,
Properties attributes)
throws XDocletException
ifHasSetMethodWithTag looks for a set method based on the attribute name from the
current method, sets the current method to that set method, and applies the template if found. This is used to
look for setters for mbean managed attributes. The set method found may be the current method.
template - a String valueattributes - a Properties value
XDocletException - if an error occurs
public String propertyTypeWithTag(Properties attributes)
throws XDocletException
propertyTypeWithTag method figures out the type for the current property with tag by looking for
a getter, then a setter.
attributes - a Properties value including the tagName required.
String fully qualified name of the property type.
XDocletException - if an error occurs
public String paramValueWithTag(Properties attributes)
throws XDocletException
attributes - The attributes of the template tag
XDocletException - Description of Exception
public void ifHasParamWithTag(String template,
Properties attributes)
throws XDocletException
attributes - The attributes of the template tagtemplate -
XDocletException - Description of Exception
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||