xdoclet.tags
Class ConfigTagsHandler

java.lang.Object
  |
  +--xdoclet.template.TemplateTagHandler
        |
        +--xdoclet.XDocletTagSupport
              |
              +--xdoclet.tags.ConfigTagsHandler

public class ConfigTagsHandler

extends XDocletTagSupport

Version:

$Revision: 1.8 $

Author:

Ara Abrahamian (ara_e@email.com)

Fields inherited from class xdoclet.XDocletTagSupport

FOR_CLASS, FOR_CONSTRUCTOR, FOR_FIELD, FOR_METHOD, PARAMETER_DELIMITER

Constructor Summary

ConfigTagsHandler()

Method Summary

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 param_name) Returns the value for the specified configuration parameter.
static int	getCurrentConfigParamIndex()
protected boolean	ifConfigParamEquals_Impl(java.lang.String template, 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.lang.String template, 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.

Methods inherited from class xdoclet.XDocletTagSupport

getClassTagValue, getClassTagValue, getConstructorTagValue, getCurrentClass, getCurrentConstructor, getCurrentField, getCurrentMethod, getCurrentPackage, getCurrentTag, getDocletContext, getFieldTagValue, getFieldTagValue, getMethodTagValue, getMethodTagValue, getParameterValue, getParameterValue, getTagValue, getTagValue, getTagValue, invalidParamValueFound, mandatoryParamNotFound, mandatoryTemplateTagParamNotFound, parsePropertyString, popCurrentClass, pushCurrentClass, replaceProperties, setCurrentClass, setCurrentConstructor, setCurrentField, setCurrentMethod, setCurrentPackage, setCurrentTag, tokenizeValue

Methods inherited from class xdoclet.template.TemplateTagHandler

generate, getContext, getEngine, getParser, setContext, setEngine, setParser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigTagsHandler

public ConfigTagsHandler()

Method Detail

getCurrentConfigParamIndex

public static int getCurrentConfigParamIndex()

getConfigParameter

public java.lang.Object getConfigParameter(java.lang.String param_name)
                                    throws XDocletException

Returns the value for the specified configuration parameter. Null if the config parameter not found.

Parameters:

param_name - Description of Parameter

Returns:

The ConfigParameter value

Throws:

XDocletException - Description of Exception

ifHasConfigParam

public void ifHasConfigParam(java.lang.String template,
                             java.util.Properties attributes)
                      throws XDocletException

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

configParameterValue

public java.lang.String configParameterValue(java.util.Properties attributes)
                                      throws XDocletException

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

forAllConfigParameters

public void forAllConfigParameters(java.lang.String template,
                                   java.util.Properties attributes)
                            throws XDocletException

Evaluate the body for all configuration parameters with the name paramName. It's basically used for java.util.Vector-based parameter types, and the body is evaluated for all items of the Vector.

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Throws:

XDocletException - Description of Exception

ifConfigParamGreaterOrEquals

public void ifConfigParamGreaterOrEquals(java.lang.String template,
                                         java.util.Properties attributes)
                                  throws XDocletException

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

ifConfigParamNotGreaterOrEquals

public void ifConfigParamNotGreaterOrEquals(java.lang.String template,
                                            java.util.Properties attributes)
                                     throws XDocletException

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

ifConfigParamEquals

public void ifConfigParamEquals(java.lang.String template,
                                java.util.Properties attributes)
                         throws XDocletException

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

ifConfigParamNotEquals

public void ifConfigParamNotEquals(java.lang.String template,
                                   java.util.Properties attributes)
                            throws XDocletException

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

ifConfigParamGreaterOrEquals_Impl

protected boolean ifConfigParamGreaterOrEquals_Impl(java.lang.String template,
                                                    java.util.Properties attributes)
                                             throws XDocletException

The implementation of ifConfigParamGreaterOrEquals and ifConfigParamNotGreaterOrEquals tags. Currently the value can only be of a float type like "2.0".

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

See Also:

ifConfigParamGreaterOrEquals(java.lang.String,java.util.Properties), ifConfigParamNotGreaterOrEquals(java.lang.String,java.util.Properties)

ifConfigParamEquals_Impl

protected boolean ifConfigParamEquals_Impl(java.lang.String template,
                                           java.util.Properties attributes)
                                    throws XDocletException

The implementation of ifConfigParamEquals and ifConfigParamEquals tags. Currently the value can only be of a float type like "2.0".

Parameters:

template - The body of the block tag

attributes - The attributes of the template tag

Returns:

Description of the Returned Value

Throws:

XDocletException - Description of Exception

See Also:

ifConfigParamEquals(java.lang.String,java.util.Properties), ifConfigParamNotEquals(java.lang.String,java.util.Properties)