xdoclet.tagshandler
Class ConfigTagsHandler
public class ConfigTagsHandler
Version:
- Ara Abrahamian (ara_e@email.com)
- namespace = "Config"
- Oct 15, 2001
String | configParameterValue(Properties attributes) - Returns the values of a configuration parameter with the name paramName.
|
void | forAllConfigParameters(String template, Properties attributes) - Evaluate the body for all configuration parameters with the name paramName.
|
Object | getConfigParameter(String paramName) - Returns the value for the specified configuration parameter.
|
static int | getCurrentConfigParamIndex() - Gets the CurrentConfigParamIndex attribute of the ConfigTagsHandler class
|
void | ifConfigParamEquals(String template, Properties attributes) - Evaluate the body if the value of the configuration parameter equals value.
|
protected boolean | ifConfigParamEquals_Impl(Properties attributes) - The implementation of ifConfigParamEquals and ifConfigParamEquals tags.
|
void | ifConfigParamGreaterOrEquals(String template, Properties attributes) - Evaluate the body if the value of the configuration parameter is greater or equal to value.
|
protected boolean | ifConfigParamGreaterOrEquals_Impl(Properties attributes) - The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags.
|
void | ifConfigParamNotEquals(String template, Properties attributes) - Evaluate the body if the value of the configuration parameter doesn't equal value.
|
void | ifConfigParamNotGreaterOrEquals(String template, Properties attributes) - Evaluate the body if the value of the configuration parameter is not greater or equal to value.
|
void | ifHasConfigParam(String template, 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 , hasTag , isTagValueEqual , mandatoryParamNotFound , mandatoryTemplateTagParamNotFound , modifiers , popCurrentClass , pushCurrentClass , setCurrentClass , setCurrentClassTag , setCurrentConstructor , setCurrentField , setCurrentFieldTag , setCurrentMethod , setCurrentMethodTag , setCurrentPackage |
configParameterValue
public String configParameterValue(Properties attributes)
throws XDocletException
Returns the values of a configuration parameter with the name paramName.
attributes
- The attributes of the template tag
- Description of the Returned Value
XDocletException
- Description of Exception
- type = "content"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."
forAllConfigParameters
public void forAllConfigParameters(String template,
Properties attributes)
throws XDocletException
Evaluate the body for all configuration parameters with the name paramName. It's basically used for
java.util.ArrayList-based parameter types, and the body is evaluated for all items of the ArrayList.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- type = "block"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."
getConfigParameter
public Object getConfigParameter(String paramName)
throws XDocletException
Returns the value for the specified configuration parameter. Null if the config parameter not found.
paramName
- Description of Parameter
- The ConfigParameter value
XDocletException
- Description of Exception
- When searching for param part of a subtask.element.param config param we rely on
bare reflection mechanism, so if we had getMyParam and we specified myparam for example (case mismatch) it
fails (in Class.getMethod). We should provide a case-insensitive solution.
getCurrentConfigParamIndex
public static int getCurrentConfigParamIndex()
Gets the CurrentConfigParamIndex attribute of the ConfigTagsHandler class
- The CurrentConfigParamIndex value
ifConfigParamEquals
public void ifConfigParamEquals(String template,
Properties attributes)
throws XDocletException
Evaluate the body if the value of the configuration parameter equals value.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- type = "block"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."
- name = "value"
optional = "false"
description = "The desired value."
ifConfigParamEquals_Impl
protected boolean ifConfigParamEquals_Impl(Properties attributes)
throws XDocletException
The implementation of ifConfigParamEquals and ifConfigParamEquals tags. Currently the value can only be of a
float type like "2.0".
attributes
- The attributes of the template tag
- Description of the Returned Value
XDocletException
- Description of Exception
ifConfigParamEquals(java.lang.String,java.util.Properties)
, ifConfigParamNotEquals(java.lang.String,java.util.Properties)
ifConfigParamGreaterOrEquals
public void ifConfigParamGreaterOrEquals(String template,
Properties attributes)
throws XDocletException
Evaluate the body if the value of the configuration parameter is greater or equal to value.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- type = "block"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."
- name = "value"
optional = "false"
description = "The desired value."
ifConfigParamGreaterOrEquals_Impl
protected boolean ifConfigParamGreaterOrEquals_Impl(Properties attributes)
throws XDocletException
The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags. Currently the value
can only be of a float type like "2.0".
attributes
- The attributes of the template tag
- Description of the Returned Value
XDocletException
- Description of Exception
ifConfigParamGreaterOrEquals(java.lang.String,java.util.Properties)
, ifConfigParamNotGreaterOrEquals(java.lang.String,java.util.Properties)
ifConfigParamNotEquals
public void ifConfigParamNotEquals(String template,
Properties attributes)
throws XDocletException
Evaluate the body if the value of the configuration parameter doesn't equal value.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- type = "block"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."
- name = "value"
optional = "false"
description = "The desired value."
ifConfigParamNotGreaterOrEquals
public void ifConfigParamNotGreaterOrEquals(String template,
Properties attributes)
throws XDocletException
Evaluate the body if the value of the configuration parameter is not greater or equal to value.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- type = "block"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."
- name = "value"
optional = "false"
description = "The desired value."
ifHasConfigParam
public void ifHasConfigParam(String template,
Properties attributes)
throws XDocletException
Evaluates the body if config parameter specified is not null.
template
- The body of the block tagattributes
- The attributes of the template tag
XDocletException
- Description of Exception
- type = "block"
- name = "paramName"
optional = "false"
description = "The config parameter name, it's a
parameter settable from within build file."