xdoclet.tagshandler
public class PropertyTagsHandler extends AbstractProgramElementTagsHandler
currentToken, matchPattern, tagTokenizer
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
PropertyTagsHandler() |
Modifier and Type | Method and Description |
---|---|
void |
forAllPropertiesWithTag(java.lang.String template,
java.util.Properties attributes)
Evaluates the body block for each property of current mbean.
|
static xjavadoc.XMethod |
getXMethodForMethodName(java.lang.String methodName)
Searches for the XMethod of the method with name methodName and returns it.
|
static xjavadoc.XMethod |
getXMethodForMethodName(java.lang.String methodName,
boolean superclasses)
Searches for the XMethod of the method with name methodName and returns it.
|
void |
ifHasGetMethodWithTag(java.lang.String template,
java.util.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(java.lang.String template,
java.util.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(java.lang.String template,
java.util.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. |
java.lang.String |
paramValueWithTag(java.util.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.
|
java.lang.String |
propertyTypeWithTag(java.util.Properties attributes)
The
propertyTypeWithTag method figures out the type for the current property with tag by looking for
a getter, then a setter. |
checkForWrap, currentToken, exceptionList, firstSentenceDescriptionOfCurrentMember, forAllMembers, forAllMemberTags, forAllMemberTagTokens, getAllClasses, getClassNameFor, getFullClassNameFor, getFullSuperclassNameFor, getIndentChars, getXExecutableMemberForMemberName, getXExecutableMemberForMemberName, hasExecutableMember_OLD, hasExecutableMember, makeCopyOfArray, matchValue, memberComment, setMatchValue, skipToken
delimit, expandClassName, generate, getCurrentClass, getCurrentClassTag, getCurrentConstructor, getCurrentField, getCurrentFieldTag, getCurrentMethod, getCurrentMethodTag, getCurrentPackage, getDocletContext, getEngine, getExpandedDelimitedTagValue, getTagValue, getTagValue, getTagValue, hasHavingClassTag, hasTag, isTagValueEqual, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, modifiers, popCurrentClass, pushCurrentClass, setCurrentClass, setCurrentClassTag, setCurrentConstructor, setCurrentField, setCurrentFieldTag, setCurrentMethod, setCurrentMethodTag, setCurrentPackage
getXJavaDoc, setXJavaDoc
public static xjavadoc.XMethod getXMethodForMethodName(java.lang.String methodName)
methodName
- The method to search forpublic static xjavadoc.XMethod getXMethodForMethodName(java.lang.String methodName, boolean superclasses)
methodName
- The method to search forsuperclasses
- Whether to also search superclassespublic void forAllPropertiesWithTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void ifHasGetMethodWithTag(java.lang.String template, java.util.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
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- if an error occurspublic void ifHasSetMethodWithTag(java.lang.String template, java.util.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
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- if an error occurspublic java.lang.String propertyTypeWithTag(java.util.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 occurspublic java.lang.String paramValueWithTag(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void ifHasParamWithTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- The body of the block tagattributes
- The attributes of the template tagXDocletException
- Description of Exception