org.apache.tomcat.util.digester

Class 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
  • an arbitrary Object defined programatically, assigned if the element pattern AND specified attribute name are matched See ObjectParamRule

Since: 1.4

Field Summary
protected StringattributeName
The attribute which we are attempting to match
protected Objectparam
The parameter we wish to pass to the method call
protected intparamIndex
The zero-relative index of the parameter we are saving.
Constructor Summary
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
voidbegin(String namespace, String name, Attributes attributes)
Process the start of this element.
StringtoString()
Render a printable version of this Rule.

Field Detail

attributeName

protected String attributeName
The attribute which we are attempting to match

param

protected Object param
The parameter we wish to pass to the method call

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

begin

public void begin(String namespace, String name, Attributes attributes)
Process the start of this element.

Parameters: attributes The attribute list for this element

toString

public String toString()
Render a printable version of this Rule.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.