Apache Struts API Documentation: Class CallParamRule

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.digester
Class CallParamRule

    java.lang.Object
      |
      +--org.apache.struts.digester.Rule
            |
            +--org.apache.struts.digester.CallParamRule

public class CallParamRule
extends Rule

Rule implementation that saves a parameter from either an attribute of this element, or from the element body, to be used in a call generated by a surrounding CallMethodRule rule.

Version:
  $Revision: 1.1 $ $Date: 2001-09-17 21:13:30 +0100 (Mon, 17 Sep 2001) $
Author:
  Craig McClanahan

Field Summary
`protected java.lang.String` | `attributeName` The attribute from which to save the parameter value
`protected java.lang.String` | `bodyText` The body text collected from this element.
`protected int` | `paramIndex` The zero-relative index of the parameter we are saving.

Fields inherited from class org.apache.struts.digester.Rule
`digester`

Constructor Summary
`CallParamRule(Digester digester, int paramIndex)` Construct a "call parameter" rule that will save the body text of this element as the parameter value.
`CallParamRule(Digester digester, int paramIndex, java.lang.String attributeName)` Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.

Method Summary
`void` | `begin(org.xml.sax.AttributeList attributes)` Process the start of this element.
`void` | `body(java.lang.String bodyText)` Process the body text of this element.
`void` | `end()` Process the end of this element.
`void` | `finish()` Clean up after parsing is complete.

Methods inherited from class java.lang.Object
`, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait`

Field Detail

### attributeName

    protected java.lang.String attributeName

  The attribute from which to save the parameter value

### bodyText

    protected java.lang.String bodyText

  The body text collected from this element.

### paramIndex

    protected int paramIndex

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

Constructor Detail

### CallParamRule

    public CallParamRule(Digester digester,
                         int paramIndex)

  Construct a "call parameter" rule that will save the body text of this element as the parameter value.
  Parameters:
    `digester` - The associated Digester
    `paramIndex` - The zero-relative parameter number

### CallParamRule

    public CallParamRule(Digester digester,
                         int paramIndex,
                         java.lang.String attributeName)

  Construct a "call parameter" rule that will save the value of the specified attribute as the parameter value.
  Parameters:
    `digester` - The associated Digester
    `paramIndex` - The zero-relative parameter number
    `attributeName` - The name of the attribute to save

Method Detail

### begin

    public void begin(org.xml.sax.AttributeList attributes)
               throws java.lang.Exception

  Process the start of this element.
  Overrides:
    `begin` in class `Rule`
  Parameters:
    `attributes` - The attribute list for this element

### body

    public void body(java.lang.String bodyText)
              throws java.lang.Exception

  Process the body text of this element.
  Overrides:
    `body` in class `Rule`
  Parameters:
    `bodyText` - The body text of this element

### end

    public void end()
             throws java.lang.Exception

  Process the end of this element.
  Overrides:
    `end` in class `Rule`

### finish

    public void finish()
                throws java.lang.Exception

  Clean up after parsing is complete.
  Overrides:
    `finish` in class `Rule`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2001 - Apache Software Foundation