org.apache.commons.digester

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

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.

Fields inherited from class org.apache.commons.digester.Rule

digester, namespaceURI

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

void
begin(String namespace, String name, Attributes attributes)
Process the start of this element.
String
toString()
Render a printable version of this Rule.

Methods inherited from class org.apache.commons.digester.Rule

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

Field Details

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 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 interface Rule
Parameters:
attributes - The attribute list for this element

toString

public String toString()
Render a printable version of this Rule.

Copyright 2001-2005 The Apache Software Foundation.