xdoclet.tagshandler

Class ConfigTagsHandler

public class ConfigTagsHandler extends XDocletTagSupport

Version: $Revision: 1.9 $

Author: Ara Abrahamian (ara_e@email.com)

UNKNOWN: Oct 15, 2001 namespace = "Config"

Method Summary
StringconfigParameterValue(Properties attributes)
Returns the values of a configuration parameter with the name paramName.
voidforAllConfigParameters(String template, Properties attributes)
Evaluate the body for all configuration parameters with the name paramName.
ObjectgetConfigParameter(String paramName)
Returns the value for the specified configuration parameter.
static intgetCurrentConfigParamIndex()
Gets the CurrentConfigParamIndex attribute of the ConfigTagsHandler class
voidifConfigParamEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter equals value.
protected booleanifConfigParamEquals_Impl(Properties attributes)
The implementation of ifConfigParamEquals and ifConfigParamEquals tags.
voidifConfigParamGreaterOrEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter is greater or equal to value.
protected booleanifConfigParamGreaterOrEquals_Impl(Properties attributes)
The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags.
voidifConfigParamNotEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter doesn't equal value.
voidifConfigParamNotGreaterOrEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter is not greater or equal to value.
voidifHasConfigParam(String template, Properties attributes)
Evaluates the body if config parameter specified is not null.

Method Detail

configParameterValue

public String configParameterValue(Properties attributes)
Returns the values of a configuration parameter with the name paramName.

Parameters: attributes The attributes of the template tag

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

UNKNOWN: 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)
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.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: 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)
Returns the value for the specified configuration parameter. Null if the config parameter not found.

Parameters: paramName Description of Parameter

Returns: The ConfigParameter value

Throws: XDocletException Description of Exception

UNKNOWN: 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

Returns: The CurrentConfigParamIndex value

ifConfigParamEquals

public void ifConfigParamEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter equals value.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: 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)
The implementation of ifConfigParamEquals and ifConfigParamEquals tags. Currently the value can only be of a float type like "2.0".

Parameters: attributes The attributes of the template tag

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

See Also: ConfigTagsHandler ConfigTagsHandler

ifConfigParamGreaterOrEquals

public void ifConfigParamGreaterOrEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter is greater or equal to value.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: 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)
The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags. Currently the value can only be of a float type like "2.0".

Parameters: attributes The attributes of the template tag

Returns: Description of the Returned Value

Throws: XDocletException Description of Exception

See Also: ConfigTagsHandler ConfigTagsHandler

ifConfigParamNotEquals

public void ifConfigParamNotEquals(String template, Properties attributes)
Evaluate the body if the value of the configuration parameter doesn't equal value.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: 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)
Evaluate the body if the value of the configuration parameter is not greater or equal to value.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: 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)
Evaluates the body if config parameter specified is not null.

Parameters: template The body of the block tag attributes The attributes of the template tag

Throws: XDocletException Description of Exception

UNKNOWN: type = "block" name = "paramName" optional = "false" description = "The config parameter name, it's a * parameter settable from within build file."