xdoclet.tagshandler
public class ConfigTagsHandler extends XDocletTagSupport
FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER
Constructor and Description |
---|
ConfigTagsHandler() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
configParameterValue(java.util.Properties attributes)
Returns the values of a configuration parameter with the name paramName.
|
void |
forAllConfigParameters(java.lang.String template,
java.util.Properties attributes)
Evaluate the body for all configuration parameters with the name paramName.
|
java.lang.Object |
getConfigParameter(java.lang.String paramName)
Returns the value for the specified configuration parameter.
|
static int |
getCurrentConfigParamIndex()
Gets the CurrentConfigParamIndex attribute of the ConfigTagsHandler class
|
protected boolean |
ifConfigParamEquals_Impl(java.util.Properties attributes)
The implementation of ifConfigParamEquals and ifConfigParamEquals tags.
|
void |
ifConfigParamEquals(java.lang.String template,
java.util.Properties attributes)
Evaluate the body if the value of the configuration parameter equals value.
|
protected boolean |
ifConfigParamGreaterOrEquals_Impl(java.util.Properties attributes)
The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags.
|
void |
ifConfigParamGreaterOrEquals(java.lang.String template,
java.util.Properties attributes)
Evaluate the body if the value of the configuration parameter is greater or equal to value.
|
void |
ifConfigParamNotEquals(java.lang.String template,
java.util.Properties attributes)
Evaluate the body if the value of the configuration parameter doesn't equal value.
|
void |
ifConfigParamNotGreaterOrEquals(java.lang.String template,
java.util.Properties attributes)
Evaluate the body if the value of the configuration parameter is not greater or equal to value.
|
void |
ifHasConfigParam(java.lang.String template,
java.util.Properties attributes)
Evaluates the body if config parameter specified is not null.
|
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 int getCurrentConfigParamIndex()
public java.lang.Object getConfigParameter(java.lang.String paramName) throws XDocletException
paramName
- Description of ParameterXDocletException
- Description of Exceptionpublic void ifHasConfigParam(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 java.lang.String configParameterValue(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of Exceptionpublic void forAllConfigParameters(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 ifConfigParamGreaterOrEquals(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 ifConfigParamNotGreaterOrEquals(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 ifConfigParamEquals(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 ifConfigParamNotEquals(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 Exceptionprotected boolean ifConfigParamGreaterOrEquals_Impl(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of ExceptionifConfigParamGreaterOrEquals(java.lang.String,java.util.Properties)
,
ifConfigParamNotGreaterOrEquals(java.lang.String,java.util.Properties)
protected boolean ifConfigParamEquals_Impl(java.util.Properties attributes) throws XDocletException
attributes
- The attributes of the template tagXDocletException
- Description of ExceptionifConfigParamEquals(java.lang.String,java.util.Properties)
,
ifConfigParamNotEquals(java.lang.String,java.util.Properties)