org.apache.commons.digester3
Class PathCallParamRule

java.lang.Object
  org.apache.commons.digester3.Rule
      org.apache.commons.digester3.PathCallParamRule

public class PathCallParamRule
extends Rule

Rule implementation that saves a parameter containing the Digester matching path for use by a surrounding CallMethodRule. This Rule is most useful when making extensive use of wildcards in rule patterns.

Since:

1.6

Field Summary

protected int

paramIndex The zero-relative index of the parameter we are saving.

Constructor Summary

PathCallParamRule(int paramIndex)
Construct a "call parameter" rule that will save the body text of this element as the parameter value.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

paramIndex

protected int paramIndex

The zero-relative index of the parameter we are saving.

Constructor Detail

PathCallParamRule

public PathCallParamRule(int paramIndex)

Construct a "call parameter" rule that will save the body text of this element as the parameter value.

Parameters:

paramIndex - The zero-relative parameter number

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