Class ObjectParamRule

java.lang.Object
org.apache.commons.digester.Rule
org.apache.commons.digester.ObjectParamRule

public class ObjectParamRule extends Rule

Rule implementation that saves a parameter for use by a surrounding CallMethodRule.

This parameter may be:

Since:
1.4
  • 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
      Process the start of this element.
      Overrides:
      begin in class Rule
      Parameters:
      attributes - The attribute list for this element
      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
      Throws:
      Exception
    • toString

      public String toString()
      Render a printable version of this Rule.
      Overrides:
      toString in class Object