public class ObjectParamRule extends Rule
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
Modifier and Type
Field and Description
protected String
attributeName
The attribute which we are attempting to match
protected Object
param
The parameter we wish to pass to the method call
protected int
paramIndex
The zero-relative index of the parameter we are saving.
-
Constructor Summary
Constructors
Constructor and Description
ObjectParamRule(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
Modifier and Type
Method and Description
void
begin(String namespace,
String name,
Attributes attributes)
This method is called when the beginning of a matching XML element is encountered.
String
toString()
-
Methods inherited from class org.apache.commons.digester3.Rule
body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI
-
-
Field Detail
-
attributeName
protected String attributeName
The attribute which we are attempting to match
-
paramIndex
protected int paramIndex
The zero-relative index of the parameter we are saving.
-
Constructor Detail
-
ObjectParamRule
public ObjectParamRule(int paramIndex,
Object param)
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
public 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.
- Parameters:
paramIndex
- The zero-relative parameter numberattributeName
- The name of the attribute to matchparam
- the parameter to pass along
-
Method Detail
-
begin
public void begin(String namespace,
String name,
Attributes attributes)
throws Exception
This method is called when the beginning of a matching XML element is encountered.
- Overrides:
begin
in class Rule
- 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
Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.