org.apache.commons.digester
public class CallParamRule extends Rule
Rule implementation that saves a parameter for use by a surrounding
CallMethodRule
.
This parameter may be:
Rule
).
See PathCallParamRule
Field Summary | |
---|---|
protected String | attributeName
The attribute from which to save the parameter value |
protected ArrayStack | bodyTextStack
Stack is used to allow nested body text to be processed.
|
protected boolean | fromStack
Is the parameter to be set from the stack? |
protected int | paramIndex
The zero-relative index of the parameter we are saving. |
protected int | stackIndex
The position of the object from the top of the stack |
Constructor Summary | |
---|---|
CallParamRule(Digester digester, int paramIndex)
Construct a "call parameter" rule that will save the body text of this
element as the parameter value.
| |
CallParamRule(Digester digester, int paramIndex, String attributeName)
Construct a "call parameter" rule that will save the value of the
specified attribute as the parameter value.
| |
CallParamRule(int paramIndex)
Construct a "call parameter" rule that will save the body text of this
element as the parameter value.
| |
CallParamRule(int paramIndex, String attributeName)
Construct a "call parameter" rule that will save the value of the
specified attribute as the parameter value.
| |
CallParamRule(int paramIndex, boolean fromStack)
Construct a "call parameter" rule.
| |
CallParamRule(int paramIndex, int stackIndex)
Constructs a "call parameter" rule which sets a parameter from the stack.
|
Method Summary | |
---|---|
void | begin(Attributes attributes)
Process the start of this element.
|
void | body(String bodyText)
Process the body text of this element.
|
void | end(String namespace, String name)
Process any body texts now. |
String | toString()
Render a printable version of this Rule. |
Deprecated: The digester instance is now set in the Digester method. Use CallParamRule instead.
Construct a "call parameter" rule that will save the body text of this element as the parameter value.Note that if the element is empty the an empty string is passed to the target method, not null. And if automatic type conversion is being applied (ie if the target function takes something other than a string as a parameter) then the conversion will fail if the converter class does not accept an empty string as valid input.
Parameters: digester The associated Digester paramIndex The zero-relative parameter number
Deprecated: The digester instance is now set in the Digester method. Use CallParamRule instead.
Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.Parameters: digester The associated Digester paramIndex The zero-relative parameter number attributeName The name of the attribute to save
Note that if the element is empty the an empty string is passed to the target method, not null. And if automatic type conversion is being applied (ie if the target function takes something other than a string as a parameter) then the conversion will fail if the converter class does not accept an empty string as valid input.
Parameters: paramIndex The zero-relative parameter number
Parameters: paramIndex The zero-relative parameter number attributeName The name of the attribute to save
Parameters: paramIndex The zero-relative parameter number fromStack should this parameter be taken from the top of the stack?
Parameters: paramIndex The zero-relative parameter number stackIndex the index of the object which will be passed as a parameter. The zeroth object is the top of the stack, 1 is the next object down and so on.
Parameters: attributes The attribute list for this element
Parameters: bodyText The body text of this element