org.apache.tomcat.util.digester
public class CallParamRule extends Rule
Rule implementation that saves a parameter for use by a surrounding
CallMethodRule
.
This parameter may be:
CallParamRule(int paramIndex, String attributeName)
CallParamRule(int paramIndex)
CallParamRule(int paramIndex, boolean fromStack)
Rule
).
See PathCallParamRule
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
attributeName
The attribute from which to save the parameter value
|
protected ArrayStack |
bodyTextStack
Stack is used to allow nested body text to be processed.
|
protected boolean |
fromStack
Is the parameter to be set from the stack?
|
protected int |
paramIndex
The zero-relative index of the parameter we are saving.
|
protected int |
stackIndex
The position of the object from the top of the stack
|
digester, namespaceURI
Constructor and Description |
---|
CallParamRule(Digester digester,
int paramIndex)
Deprecated.
The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule) method.
Use CallParamRule(int paramIndex) instead. |
CallParamRule(Digester digester,
int paramIndex,
java.lang.String attributeName)
Deprecated.
The digester instance is now set in the
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule) method.
Use CallParamRule(int paramIndex, String attributeName) instead. |
CallParamRule(int paramIndex)
Construct a "call parameter" rule that will save the body text of this
element as the parameter value.
|
CallParamRule(int paramIndex,
boolean fromStack)
Construct a "call parameter" rule.
|
CallParamRule(int paramIndex,
int stackIndex)
Constructs a "call parameter" rule which sets a parameter from the stack.
|
CallParamRule(int paramIndex,
java.lang.String attributeName)
Construct a "call parameter" rule that will save the value of the
specified attribute as the parameter value.
|
Modifier and Type | Method and Description |
---|---|
void |
begin(org.xml.sax.Attributes attributes)
Process the start of this element.
|
void |
body(java.lang.String bodyText)
Process the body text of this element.
|
void |
end(java.lang.String namespace,
java.lang.String name)
Process any body texts now.
|
java.lang.String |
toString()
Render a printable version of this Rule.
|
begin, body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI
protected java.lang.String attributeName
protected int paramIndex
protected boolean fromStack
protected int stackIndex
protected ArrayStack bodyTextStack
public CallParamRule(Digester digester, int paramIndex)
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule)
method.
Use CallParamRule(int paramIndex)
instead.digester
- The associated DigesterparamIndex
- The zero-relative parameter numberpublic CallParamRule(Digester digester, int paramIndex, java.lang.String attributeName)
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule)
method.
Use CallParamRule(int paramIndex, String attributeName)
instead.digester
- The associated DigesterparamIndex
- The zero-relative parameter numberattributeName
- The name of the attribute to savepublic CallParamRule(int paramIndex)
paramIndex
- The zero-relative parameter numberpublic CallParamRule(int paramIndex, java.lang.String attributeName)
paramIndex
- The zero-relative parameter numberattributeName
- The name of the attribute to savepublic CallParamRule(int paramIndex, boolean fromStack)
paramIndex
- The zero-relative parameter numberfromStack
- should this parameter be taken from the top of the stack?public CallParamRule(int paramIndex, int stackIndex)
paramIndex
- The zero-relative parameter numberstackIndex
- 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.public void begin(org.xml.sax.Attributes attributes) throws java.lang.Exception
public void body(java.lang.String bodyText) throws java.lang.Exception
public void end(java.lang.String namespace, java.lang.String name)
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2000-2014 Apache Software Foundation. All Rights Reserved.