xdoclet.tagshandler
public class PropertyTagsHandler extends AbstractProgramElementTagsHandler
Version: $Revision: 1.13 $
UNKNOWN: Wed Feb 27 21:53:15 2002 namespace = "Property"
Method Summary | |
---|---|
void | forAllPropertiesWithTag(String template, Properties attributes)
Evaluates the body block for each property of current mbean. |
static XMethod | getXMethodForMethodName(String methodName)
Searches for the XMethod of the method with name methodName and returns it. |
static XMethod | getXMethodForMethodName(String methodName, boolean superclasses)
Searches for the XMethod of the method with name methodName and returns it. |
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.
|
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 = "Include * properties of superclasses. True by default." name = "tagName" optional = "false" description = "The required tag for methods to be * considered a getter or setter. For example, jmx.managed-attribute." i18n
Parameters: methodName The method to search for
Returns: The matching XMethod or null if not found
Parameters: methodName The method to search for superclasses Whether to also search superclasses
Returns: The matching XMethod or null if not found
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.
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException if an error occurs
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The required tag for methods to be * considered a getter or setter. For example, jmx.managed-attribute."
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 required for a getter or * setter to belong to a property." name = "paramName" description = "The parameter name. Required for property parameter * values. content of the tag is returned."
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.
Parameters: template The body of the block tag attributes The attributes of the template tag
Throws: XDocletException if an error occurs
UNKNOWN: type = "block" name = "tagName" optional = "false" description = "The required tag for methods to be * considered a getter or setter. For example, jmx.managed-attribute."
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 required for a getter or * setter to belong to a property." name = "paramName" description = "The parameter name. Required for property parameter * values. content of the tag is returned." name = "default" description = "The default value is returned if there is no value for * the parameter requested.
propertyTypeWithTag
method figures out the type for the current property with tag by looking for
a getter, then a setter.
Parameters: attributes a Properties
value including the tagName required.
Returns: the String
fully qualified name of the property type.
Throws: XDocletException if an error occurs
UNKNOWN: type = "content" name = "tagName" optional = "false" description = "The required tag for methods to be * considered a getter or setter. For example, jmx:managed-attribute." i18n