| xdoclet.modules.ojb.OjbMemberTagsHandler
| Method Summary | |
| public void | forAllMemberTagTokens(String template, Properties attributes)
Iterates over all tokens in current member tag with the name tagName and evaluates the body for every token. | | public void | forAllMemberTags(String template, Properties attributes)
Iterates over all tags of current member and evaluates the template for each one. | | public void | forAllMembers(String template, Properties attributes)
The forAllMembers method iterates through all fields of the current class. | | public static int | getMemberDimension()
Returns the dimension of the type of the current member. | | public static String | getMemberName()
Returns the name of the current member which is the name in the case of a field, or the property name for an
accessor method. | | public static XClass | getMemberType()
Returns the type of the current member which is the type in the case of a field, the return type for a getter
method, or the type of the parameter for a setter method. | | public void | ifDoesntHaveMemberTag(String template, Properties attributes)
Evaluates the body if current member has no tag with the specified name. | | public void | ifHasMemberTag(String template, Properties attributes)
Evaluates the body if current member has at least one tag with the specified name. | | public void | ifHasMemberWithTag(String template, Properties attributes)
Evaluates the body if the current class has at least one member with at least one tag with the specified name. | | public void | ifMemberTagValueEquals(String template, Properties attributes)
Evaluates the body if value for the member tag equals the specified value. | | public void | isField(String template, Properties attributes)
The isField processes the template body if the current member is a field. | | public void | isMethod(String template, Properties attributes)
The isMethod processes the template body if the current member is a method. | | public String | memberName(Properties attributes)
Returns the name of the member which is the name in the case of a field, or the property name for an accessor
method. | | public String | memberTagValue(Properties attributes)
|
| forAllMemberTagTokens | | public void forAllMemberTagTokens(String template, Properties attributes) throws XDocletException(Code) | | Iterates over all tokens in current member tag with the name tagName and evaluates the body for every token.
Parameters:
template - The body of the block tag
Parameters:
attributes - The attributes of the template tag
exception:
XDocletException - If an error occurs |
| forAllMemberTags | | public void forAllMemberTags(String template, Properties attributes) throws XDocletException(Code) | | Iterates over all tags of current member and evaluates the template for each one.
Parameters:
template - The template to be evaluated
Parameters:
attributes - The attributes of the template tag
exception:
XDocletException - If an error occurs |
| forAllMembers | | public void forAllMembers(String template, Properties attributes) throws XDocletException(Code) | | The forAllMembers method iterates through all fields of the current class. In contrast to the FieldTagsHandler.forAllFields
method, this method operates on both fields and accessors (get/set/is-methods). In addition, the method
automatically includes all supertype-fields (i.e., accessors for base interfaces) if the corresponding attribute
is set (superclasses). The fields can optionally be limited to those posessing a specified tag.
Parameters:
template - a String value
Parameters:
attributes - a Properties value
exception:
XDocletException - if an error occurs |
| getMemberDimension | | public static int getMemberDimension() throws XDocletException(Code) | | Returns the dimension of the type of the current member.
The member dimension
exception:
XDocletException - if an error occurs
See Also: OjbMemberTagsHandler.getMemberType |
| getMemberName | | public static String getMemberName() throws XDocletException(Code) | | Returns the name of the current member which is the name in the case of a field, or the property name for an
accessor method.
The member name
exception:
XDocletException - if an error occurs |
| getMemberType | | public static XClass getMemberType() throws XDocletException(Code) | | Returns the type of the current member which is the type in the case of a field, the return type for a getter
method, or the type of the parameter for a setter method.
The member type
exception:
XDocletException - if an error occurs |
| ifDoesntHaveMemberTag | | public void ifDoesntHaveMemberTag(String template, Properties attributes) throws XDocletException(Code) | | Evaluates the body if current member has no tag with the specified name.
Parameters:
template - The body of the block tag
Parameters:
attributes - The attributes of the template tag
exception:
XDocletException - Description of Exception |
| ifHasMemberTag | | public void ifHasMemberTag(String template, Properties attributes) throws XDocletException(Code) | | Evaluates the body if current member has at least one tag with the specified name.
Parameters:
template - The body of the block tag
Parameters:
attributes - The attributes of the template tag
exception:
XDocletException - Description of Exception |
| ifHasMemberWithTag | | public void ifHasMemberWithTag(String template, Properties attributes) throws XDocletException(Code) | | Evaluates the body if the current class has at least one member with at least one tag with the specified name.
Parameters:
template - The body of the block tag
Parameters:
attributes - The attributes of the template tag
exception:
XDocletException - Description of Exception |
| ifMemberTagValueEquals | | public void ifMemberTagValueEquals(String template, Properties attributes) throws XDocletException(Code) | | Evaluates the body if value for the member tag equals the specified value.
Parameters:
template - The body of the block tag
Parameters:
attributes - The attributes of the template tag
exception:
XDocletException - If an error occurs |
| isField | | public void isField(String template, Properties attributes) throws XDocletException(Code) | | The isField processes the template body if the current member is a field.
Parameters:
template - a String value
Parameters:
attributes - a Properties value
exception:
XDocletException - if an error occurs |
| isMethod | | public void isMethod(String template, Properties attributes) throws XDocletException(Code) | | The isMethod processes the template body if the current member is a method.
Parameters:
template - a String value
Parameters:
attributes - a Properties value
exception:
XDocletException - if an error occurs |
| memberName | | public String memberName(Properties attributes) throws XDocletException(Code) | | Returns the name of the member which is the name in the case of a field, or the property name for an accessor
method.
Parameters:
attributes - The attributes of the template tag The member name
exception:
XDocletException - if an error occurs |
| memberTagValue | | public String memberTagValue(Properties attributes) throws XDocletException(Code) | | Returns the value of the tag/parameter combination for the current member tag
Parameters:
attributes - The attributes of the template tag Description of the Returned Value
exception:
XDocletException - Description of Exception |
|
|