Package org.apache.tomcat.util.digester
Class ObjectParamRule
- java.lang.Object
-
- org.apache.tomcat.util.digester.Rule
-
- 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:
- an arbitrary Object defined programatically, assigned when the element pattern associated with the Rule is matched
See
ObjectParamRule(int paramIndex, Object param)
- an arbitrary Object defined programatically, assigned if the element pattern AND specified attribute name are matched
See
ObjectParamRule(int paramIndex, String attributeName, Object param)
- Since:
- 1.4
- an arbitrary Object defined programatically, assigned when the element pattern associated with the Rule is matched
See
-
-
Field Summary
Fields Modifier and Type Field Description protected String
attributeName
The attribute which we are attempting to matchprotected Object
param
The parameter we wish to pass to the method callprotected 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
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.tomcat.util.digester.Rule
begin, body, body, end, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI
-
-
-
-
Constructor Detail
-
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 numberparam
- 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 numberattributeName
- The name of the attribute to matchparam
- the parameter to pass along
-
-
Method Detail
-
begin
public void begin(String namespace, String name, Attributes attributes) throws Exception
Process the start of this element.- Overrides:
begin
in classRule
- Parameters:
attributes
- The attribute list for this elementnamespace
- the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespacename
- the local name if the parser is namespace aware, or just the element name otherwise- Throws:
Exception
-
-