|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectxdoclet.template.TemplateTagHandler
xdoclet.XDocletTagSupport
xdoclet.modules.ejb.env.EnvTagsHandler
public class EnvTagsHandler
Handles field level tag's for configuring a bean's environment.
Field Summary | |
---|---|
protected xjavadoc.XMember |
currentMember
|
protected xjavadoc.XTag |
currentTag
|
protected int |
currentTagType
|
Fields inherited from class xdoclet.XDocletTagSupport |
---|
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER |
Constructor Summary | |
---|---|
EnvTagsHandler()
|
Method Summary | |
---|---|
protected void |
doGenerate(java.lang.String template)
Called for each tag in the forTags loop. |
void |
forAllMemberTags(java.lang.String template,
java.util.Properties attributes)
Executes the template for all method- and field-level tags with the passed name |
void |
forAllMethodTags(java.lang.String template,
java.util.Properties attributes)
Executes the template for all method-level tags with the passed name |
void |
forAllTags(java.lang.String template,
java.util.Properties attributes)
Executes the template for all class-, method- and field-level tags with the passed name |
protected void |
forTags(java.lang.String template,
java.util.Properties attributes,
boolean forClass,
boolean forMethod,
boolean forField)
Executes the passed template for the passed |
void |
ifHasParam(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the current tag has a specified parameter |
void |
ifHasTag(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the current class has at least one ot the passed tags at field- or method-level |
void |
ifHasType(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the current tag is either a method- or fiel-level tag or has a type parameter. |
void |
ifNotPrimitiveMember(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the current field type or method return type is not a primitive. |
void |
ifParamValueEquals(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the specified tag's value is equal to the specified value |
void |
ifParamValueNotEquals(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the specified tag's value is equal to the specified value |
void |
ifPrimitiveMember(java.lang.String template,
java.util.Properties attributes)
Executes the body only if the current field type or method return type is primitive. |
java.lang.String |
memberName(java.util.Properties attributes)
Returns the method or field name. |
java.lang.String |
memberType()
Returns the method's return type or the field's type. |
java.lang.String |
methodSignature()
Returns the method signature for the current method. |
java.lang.String |
name(java.util.Properties attributes)
Returns the name parameter value for the current tag. |
java.lang.String |
paramValue(java.util.Properties attributes)
Returns the value of a parameter. |
java.lang.String |
type(java.util.Properties attributes)
Returns the type parameter value for the current tag. |
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 |
Field Detail |
---|
protected xjavadoc.XTag currentTag
protected xjavadoc.XMember currentMember
protected int currentTagType
Constructor Detail |
---|
public EnvTagsHandler()
Method Detail |
---|
public void forAllTags(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void forAllMemberTags(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void forAllMethodTags(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic java.lang.String name(java.util.Properties attributes) throws XDocletException
attributes
- the attributes
XDocletException
- if an error occurespublic java.lang.String type(java.util.Properties attributes) throws XDocletException
attributes
- the attributes
XDocletException
- if an error occurespublic void ifHasType(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic java.lang.String memberName(java.util.Properties attributes) throws XDocletException
forAllMemberTags
or forAllMethodTags
.
attributes
- the attributes
XDocletException
- if an error occurespublic java.lang.String memberType() throws XDocletException
forAllMemberTags
or
forAllMethodTags
.
XDocletException
- if an error occurespublic java.lang.String methodSignature() throws XDocletException
forAllMethodTags
.
XDocletException
- if an error occurespublic java.lang.String paramValue(java.util.Properties attributes) throws XDocletException
attributes
- the attributes
XDocletException
- if an error occurespublic void ifHasParam(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void ifParamValueEquals(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void ifParamValueNotEquals(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void ifPrimitiveMember(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void ifNotPrimitiveMember(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occurespublic void ifHasTag(java.lang.String template, java.util.Properties attributes) throws XDocletException
template
- the templateattributes
- the attributes
XDocletException
- if an error occuresprotected void forTags(java.lang.String template, java.util.Properties attributes, boolean forClass, boolean forMethod, boolean forField) throws XDocletException
template
- the templateattributes
- the parametersforClass
- indicates whether the template should be excuted for class level tagsforMethod
- indicates whether the template should be excuted for method level tagsforField
- indicates whether the template should be excuted for field level tags
XDocletException
- if an error occuresprotected void doGenerate(java.lang.String template) throws XDocletException
forTags
loop. The default behaviour is to call generate(template)
template
- the template
XDocletException
- if an error occures
|
http://xdoclet.sourceforge.net/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |