org.apache.commons.digester: public class: PathCallParamRule

org.apache.commons.digester
public class: PathCallParamRule [javadoc | source]

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

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.

Fields inherited from org.apache.commons.digester.Rule:
digester, namespaceURI

Constructor:

Constructor:
public PathCallParamRule(int paramIndex) { this.paramIndex = 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

 public PathCallParamRule(int paramIndex) {
        this.paramIndex = 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 from org.apache.commons.digester.PathCallParamRule Summary:
begin, toString

Methods from org.apache.commons.digester.Rule:
begin, begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.commons.digester.PathCallParamRule Detail:
public void begin(String namespace, String name, Attributes attributes) throws Exception { // --------------------------------------------------------- Public Methods String param = getDigester().getMatch(); if(param != null) { Object parameters[] = (Object[]) digester.peekParams(); parameters[paramIndex] = param; } } Process the start of this element.
public String toString() { StringBuffer sb = new StringBuffer("PathCallParamRule["); sb.append("paramIndex="); sb.append(paramIndex); sb.append("]"); return (sb.toString()); } Render a printable version of this Rule.

Method from org.apache.commons.digester.PathCallParamRule Detail:

 public  void begin(String namespace,
    String name,
    Attributes attributes) throws Exception {
    // --------------------------------------------------------- Public Methods
        String param = getDigester().getMatch();
        if(param != null) {
            Object parameters[] = (Object[]) digester.peekParams();
            parameters[paramIndex] = param;
        }
}

Process the start of this element.

 public String toString() {
        StringBuffer sb = new StringBuffer("PathCallParamRule[");
        sb.append("paramIndex=");
        sb.append(paramIndex);
        sb.append("]");
        return (sb.toString());
}

Render a printable version of this Rule.