Class ObjectParamRule

java.lang.Object

org.apache.commons.digester3.Rule

org.apache.commons.digester3.ObjectParamRule

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	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	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

Modifier and Type	Method	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 Rule

body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI

Methods inherited from class Object

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

Field Details

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.

param

protected Object param

The parameter we wish to pass to the method call

Constructor Details

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 number

param - 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 number

attributeName - The name of the attribute to match

param - the parameter to pass along

Method Details

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 namespace

name - the local name if the parser is namespace aware, or just the element name otherwise

attributes - The attribute list of this element

Throws:

Exception - if any error occurs

toString

public String toString()

Overrides:

toString in class Object