Overview  Package   Class  Tree  Deprecated  Index  Help 
Apache Tomcat 6.0.53
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.tomcat.util.digester
Class ObjectParamRule

java.lang.Object
  extended by org.apache.tomcat.util.digester.Rule
      extended by org.apache.tomcat.util.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 Summary
protected  java.lang.String attributeName
          The attribute which we are attempting to match
protected  java.lang.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.tomcat.util.digester.Rule
digester, namespaceURI
 
Constructor Summary
ObjectParamRule(int paramIndex, java.lang.Object param)
          Construct a "call parameter" rule that will save the given Object as the parameter value.
ObjectParamRule(int paramIndex, java.lang.String attributeName, java.lang.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(java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes attributes)
          Process the start of this element.
 java.lang.String toString()
          Render a printable version of this Rule.
 
Methods inherited from class org.apache.tomcat.util.digester.Rule
begin, body, body, end, 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

attributeName

protected java.lang.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 java.lang.Object param
The parameter we wish to pass to the method call

Constructor Detail

ObjectParamRule

public ObjectParamRule(int paramIndex,
                       java.lang.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,
                       java.lang.String attributeName,
                       java.lang.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(java.lang.String namespace,
                  java.lang.String name,
                  org.xml.sax.Attributes attributes)
           throws java.lang.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:
java.lang.Exception

toString

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

Overrides:
toString in class java.lang.Object
Overview  Package   Class  Tree  Deprecated  Index  Help 
Apache Tomcat 6.0.53
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.