Package org.apache.commons.digester3.annotations.rules

Annotation Type CallParam

@Documented
@Retention(RUNTIME)
@Target(PARAMETER)
@DigesterRule(reflectsRule=CallParamRule.class,
              handledBy=CallParamHandler.class)
public @interface CallParam

Methods arguments annotated with CallParam will be bound with CallParamRule digester rule.

Since:

2.1

See Also:

Digester.addCallParam(String,int)

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
java.lang.String	pattern	The element matching pattern.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
java.lang.String	attributeName	The attribute from which to save the parameter value.
boolean	fromStack	Flags the parameter to be set from the stack.
java.lang.String	namespaceURI	The namespace URI for which this Rule is relevant, if any.
int	stackIndex	Sets the position of the object from the top of the stack.

Element Detail

pattern

java.lang.String pattern

The element matching pattern.

namespaceURI

java.lang.String namespaceURI

The namespace URI for which this Rule is relevant, if any.

Since:

3.0

Default:

""

attributeName

java.lang.String attributeName

The attribute from which to save the parameter value.

Since:

3.0

Default:

""

fromStack

boolean fromStack

Flags the parameter to be set from the stack.

Since:

3.0

Default:

false

stackIndex

int stackIndex

Sets the position of the object from the top of the stack.

Since:

3.0

Default:

0