org.apache.commons.digester
Class CallMethodRule
public class CallMethodRule
Rule implementation that calls a method on an object on the stack
(normally the top/parent object), passing arguments collected from
subsequent
CallParamRule
rules or from the body of this
element.
By using
CallMethodRule(String methodName)
a method call can be made to a method which accepts no
arguments.
Incompatible method parameter types are converted
using
org.apache.commons.beanutils.ConvertUtils
.
This rule now uses
MethodUtils.invokeMethod
by default.
This increases the kinds of methods successfully and allows primitives
to be matched by passing in wrapper classes.
There are rare cases when
MethodUtils.invokeExactMethod
(the old defualt) is required.
This method is much stricter in it's reflection.
Setting the
UseExactMatch
to true reverts to the use of this
method.
Note that the target method is invoked when the
end of
the tag the CallMethodRule fired on is encountered,
not when the
last parameter becomes available. This implies that rules which fire on
tags nested within the one associated with the CallMethodRule will
fire before the CallMethodRule invokes the target method. This behaviour is
not configurable.
Note also that if a CallMethodRule is expecting exactly one parameter
and that parameter is not available (eg CallParamRule is used with an
attribute name but the attribute does not exist) then the method will
not be invoked. If a CallMethodRule is expecting more than one parameter,
then it is always invoked, regardless of whether the parameters were
available or not (missing parameters are passed as null values).
protected String | bodyText - The body text collected from this element.
|
protected String | methodName - The method name to call on the parent object.
|
private String[] | paramClassNames - The names of the classes of the parameters to be collected.
|
protected int | paramCount - The number of parameters to collect from
MethodParam rules.
|
protected Class[] | paramTypes - The parameter types of the parameters to be collected.
|
private int | targetOffset - location of the target object for the call, relative to the
top of the digester object stack.
|
protected boolean | useExactMatch - Should
MethodUtils.invokeExactMethod be used for reflection.
|
CallMethodRule(String methodName) - Construct a "call method" rule with the specified method name.
|
CallMethodRule(String methodName, int paramCount) - Construct a "call method" rule with the specified method name.
|
CallMethodRule(String methodName, int paramCount, paramTypes[] ) - Construct a "call method" rule with the specified method name and
parameter types.
|
CallMethodRule(String methodName, int paramCount, paramTypes[] ) - Construct a "call method" rule with the specified method name and
parameter types.
|
CallMethodRule(int targetOffset, String methodName) - Construct a "call method" rule with the specified method name.
|
CallMethodRule(int targetOffset, String methodName, int paramCount) - Construct a "call method" rule with the specified method name.
|
CallMethodRule(int targetOffset, String methodName, int paramCount, paramTypes[] ) - Construct a "call method" rule with the specified method name and
parameter types.
|
CallMethodRule(int targetOffset, String methodName, int paramCount, paramTypes[] ) - Construct a "call method" rule with the specified method name and
parameter types.
|
CallMethodRule(Digester digester, String methodName, int paramCount) - The digester instance is now set in the
Digester.addRule(String,Rule) method.
|
CallMethodRule(Digester digester, String methodName, int paramCount, paramTypes[] ) - The digester instance is now set in the
Digester.addRule(String,Rule) method.
|
CallMethodRule(Digester digester, String methodName, int paramCount, paramTypes[] ) - The digester instance is now set in the
Digester.addRule(String,Rule) method.
|
void | begin(Attributes attributes) - Process the start of this element.
|
void | body(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.
|
boolean | getUseExactMatch() - Should
MethodUtils.invokeExactMethod
be used for the reflection.
|
protected void | processMethodCallResult(Object result) - Subclasses may override this method to perform additional processing of the
invoked method's result.
|
void | setDigester(Digester digester) - Set the associated digester.
|
void | setUseExactMatch(boolean useExactMatch) - Set whether
MethodUtils.invokeExactMethod
should be used for the reflection.
|
String | toString() - Render a printable version of this Rule.
|
begin , begin , body , body , end , end , finish , getDigester , getNamespaceURI , setDigester , setNamespaceURI |
bodyText
protected String bodyText
The body text collected from this element.
methodName
protected String methodName
The method name to call on the parent object.
paramClassNames
private String[] paramClassNames
The names of the classes of the parameters to be collected.
This attribute allows creation of the classes to be postponed until the digester is set.
paramCount
protected int paramCount
The number of parameters to collect from MethodParam
rules.
If this value is zero, a single parameter will be collected from the
body of this element.
paramTypes
protected Class[] paramTypes
The parameter types of the parameters to be collected.
targetOffset
private int targetOffset
location of the target object for the call, relative to the
top of the digester object stack. The default value of zero
means the target object is the one on top of the stack.
useExactMatch
protected boolean useExactMatch
Should MethodUtils.invokeExactMethod
be used for reflection.
CallMethodRule
public CallMethodRule(String methodName)
Construct a "call method" rule with the specified method name.
The method should accept no parameters.
methodName
- Method name of the parent method to call
CallMethodRule
public CallMethodRule(String methodName,
int paramCount)
Construct a "call method" rule with the specified method name. The
parameter types (if any) default to java.lang.String.
methodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of this element.
CallMethodRule
public CallMethodRule(String methodName,
int paramCount,
paramTypes[] )
Construct a "call method" rule with the specified method name and
parameter types. If paramCount
is set to zero the rule
will use the body of this element as the single argument of the
method, unless paramTypes
is null or empty, in this
case the rule will call the specified method with no arguments.
methodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of ths element
CallMethodRule
public CallMethodRule(String methodName,
int paramCount,
paramTypes[] )
Construct a "call method" rule with the specified method name and
parameter types. If paramCount
is set to zero the rule
will use the body of this element as the single argument of the
method, unless paramTypes
is null or empty, in this
case the rule will call the specified method with no arguments.
methodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of ths element
CallMethodRule
public CallMethodRule(int targetOffset,
String methodName)
Construct a "call method" rule with the specified method name.
The method should accept no parameters.
targetOffset
- location of the target object. Positive numbers are
relative to the top of the digester object stack. Negative numbers
are relative to the bottom of the stack. Zero implies the top
object on the stack.methodName
- Method name of the parent method to call
CallMethodRule
public CallMethodRule(int targetOffset,
String methodName,
int paramCount)
Construct a "call method" rule with the specified method name. The
parameter types (if any) default to java.lang.String.
targetOffset
- location of the target object. Positive numbers are
relative to the top of the digester object stack. Negative numbers
are relative to the bottom of the stack. Zero implies the top
object on the stack.methodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of this element.
CallMethodRule
public CallMethodRule(int targetOffset,
String methodName,
int paramCount,
paramTypes[] )
Construct a "call method" rule with the specified method name and
parameter types. If paramCount
is set to zero the rule
will use the body of this element as the single argument of the
method, unless paramTypes
is null or empty, in this
case the rule will call the specified method with no arguments.
targetOffset
- location of the target object. Positive numbers are
relative to the top of the digester object stack. Negative numbers
are relative to the bottom of the stack. Zero implies the top
object on the stack.methodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of ths element
CallMethodRule
public CallMethodRule(int targetOffset,
String methodName,
int paramCount,
paramTypes[] )
Construct a "call method" rule with the specified method name and
parameter types. If paramCount
is set to zero the rule
will use the body of this element as the single argument of the
method, unless paramTypes
is null or empty, in this
case the rule will call the specified method with no arguments.
targetOffset
- location of the target object. Positive numbers are
relative to the top of the digester object stack. Negative numbers
are relative to the bottom of the stack. Zero implies the top
object on the stack.methodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of ths element
CallMethodRule
public CallMethodRule(Digester digester,
String methodName,
int paramCount)
The digester instance is now set in the Digester.addRule(String,Rule)
method.
Use CallMethodRule(String methodName,int paramCount)
instead.
Construct a "call method" rule with the specified method name. The
parameter types (if any) default to java.lang.String.
digester
- The associated DigestermethodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of this element.
CallMethodRule
public CallMethodRule(Digester digester,
String methodName,
int paramCount,
paramTypes[] )
The digester instance is now set in the Digester.addRule(String,Rule)
method.
Use CallMethodRule(String methodName,int paramCount, String [] paramTypes)
instead.
Construct a "call method" rule with the specified method name.
digester
- The associated DigestermethodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of ths element
CallMethodRule
public CallMethodRule(Digester digester,
String methodName,
int paramCount,
paramTypes[] )
The digester instance is now set in the Digester.addRule(String,Rule)
method.
Use CallMethodRule(String methodName,int paramCount, Class [] paramTypes)
instead.
Construct a "call method" rule with the specified method name.
digester
- The associated DigestermethodName
- Method name of the parent method to callparamCount
- The number of parameters to collect, or
zero for a single argument from the body of ths element
begin
public void begin(Attributes attributes)
throws Exception
Process the start of this element.
- begin in interface Rule
attributes
- The attribute list for this element
body
public void body(String bodyText)
throws Exception
Process the body text of this element.
- body in interface Rule
bodyText
- The body text of this element
end
public void end()
throws Exception
Process the end of this element.
- end in interface Rule
finish
public void finish()
throws Exception
Clean up after parsing is complete.
- finish in interface Rule
getUseExactMatch
public boolean getUseExactMatch()
Should MethodUtils.invokeExactMethod
be used for the reflection.
processMethodCallResult
protected void processMethodCallResult(Object result)
Subclasses may override this method to perform additional processing of the
invoked method's result.
result
- the Object returned by the method invoked, possibly null
setDigester
public void setDigester(Digester digester)
Set the associated digester.
If needed, this class loads the parameter classes from their names.
- setDigester in interface Rule
setUseExactMatch
public void setUseExactMatch(boolean useExactMatch)
Set whether MethodUtils.invokeExactMethod
should be used for the reflection.
toString
public String toString()
Render a printable version of this Rule.
Copyright (c) 2001-2004 - Apache Software Foundation