| java.lang.Object org.apache.tomcat.util.digester.Rule org.apache.tomcat.util.digester.CallParamRule
CallParamRule | public class CallParamRule extends Rule (Code) | | Rule implementation that saves a parameter for use by a surrounding
CallMethodRule.
This parameter may be:
|
Constructor Summary | |
public | CallParamRule(Digester digester, int paramIndex) Construct a "call parameter" rule that will save the body text of this
element as the parameter value. | public | CallParamRule(Digester digester, int paramIndex, String attributeName) Construct a "call parameter" rule that will save the value of the
specified attribute as the parameter value. | public | CallParamRule(int paramIndex) Construct a "call parameter" rule that will save the body text of this
element as the parameter value. | public | CallParamRule(int paramIndex, String attributeName) Construct a "call parameter" rule that will save the value of the
specified attribute as the parameter value. | public | CallParamRule(int paramIndex, boolean fromStack) Construct a "call parameter" rule. | public | CallParamRule(int paramIndex, int stackIndex) Constructs a "call parameter" rule which sets a parameter from the stack.
If the stack contains too few objects, then the parameter will be set to null.
Parameters: paramIndex - The zero-relative parameter number Parameters: stackIndex - the index of the object which will be passed as a parameter. |
Method Summary | |
public void | begin(Attributes attributes) Process the start of this element. | public void | body(String bodyText) Process the body text of this element. | public void | end(String namespace, String name) Process any body texts now. | public String | toString() Render a printable version of this Rule. |
attributeName | protected String attributeName(Code) | | The attribute from which to save the parameter value
|
bodyTextStack | protected ArrayStack bodyTextStack(Code) | | Stack is used to allow nested body text to be processed.
Lazy creation.
|
fromStack | protected boolean fromStack(Code) | | Is the parameter to be set from the stack?
|
paramIndex | protected int paramIndex(Code) | | The zero-relative index of the parameter we are saving.
|
stackIndex | protected int stackIndex(Code) | | The position of the object from the top of the stack
|
CallParamRule | public CallParamRule(int paramIndex)(Code) | | 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 |
CallParamRule | public CallParamRule(int paramIndex, String attributeName)(Code) | | Construct a "call parameter" rule that will save the value of the
specified attribute as the parameter value.
Parameters: paramIndex - The zero-relative parameter number Parameters: attributeName - The name of the attribute to save |
CallParamRule | public CallParamRule(int paramIndex, boolean fromStack)(Code) | | Construct a "call parameter" rule.
Parameters: paramIndex - The zero-relative parameter number Parameters: fromStack - should this parameter be taken from the top of the stack? |
CallParamRule | public CallParamRule(int paramIndex, int stackIndex)(Code) | | Constructs a "call parameter" rule which sets a parameter from the stack.
If the stack contains too few objects, then the parameter will be set to null.
Parameters: paramIndex - The zero-relative parameter number Parameters: stackIndex - the index of the object which will be passed as a parameter. The zeroth object is the top of the stack, 1 is the next object down and so on. |
begin | public void begin(Attributes attributes) throws Exception(Code) | | Process the start of this element.
Parameters: attributes - The attribute list for this element |
body | public void body(String bodyText) throws Exception(Code) | | Process the body text of this element.
Parameters: bodyText - The body text of this element |
toString | public String toString()(Code) | | Render a printable version of this Rule.
|
|
|