Package org.apache.commons.digester3
Class ObjectParamRule
java.lang.Object
org.apache.commons.digester3.Rule
org.apache.commons.digester3.ObjectParamRule
Rule implementation that saves a parameter for use by a surrounding CallMethodRule
.
This parameter may be:
- an arbitrary Object defined programatically, assigned when the element pattern associated with the Rule is
matched. See
ObjectParamRule(int paramIndex, Object param)
. - an arbitrary Object defined programatically, assigned if the element pattern AND specified attribute name are
matched. See
ObjectParamRule(int paramIndex, String attributeName, Object param)
.
- Since:
- 1.4
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionObjectParamRule
(int paramIndex, Object param) Construct a "call parameter" rule that will save the given Object as the parameter value.ObjectParamRule
(int paramIndex, String attributeName, Object param) Construct a "call parameter" rule that will save the given Object as the parameter value, provided that the specified attribute exists. -
Method Summary
Methods inherited from class org.apache.commons.digester3.Rule
body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI
-
Field Details
-
attributeName
The attribute which we are attempting to match -
paramIndex
protected int paramIndexThe zero-relative index of the parameter we are saving. -
param
The parameter we wish to pass to the method call
-
-
Constructor Details
-
ObjectParamRule
Construct a "call parameter" rule that will save the given Object as the parameter value.- Parameters:
paramIndex
- The zero-relative parameter numberparam
- the parameter to pass along
-
ObjectParamRule
Construct a "call parameter" rule that will save the given Object as the parameter value, provided that the specified attribute exists.- Parameters:
paramIndex
- The zero-relative parameter numberattributeName
- The name of the attribute to matchparam
- the parameter to pass along
-
-
Method Details
-
begin
This method is called when the beginning of a matching XML element is encountered.- Overrides:
begin
in classRule
- Parameters:
namespace
- the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespacename
- the local name if the parser is namespace aware, or just the element name otherwiseattributes
- The attribute list of this element- Throws:
Exception
- if any error occurs
-
toString
-