| java.lang.Object org.apache.tomcat.util.digester.Rule org.apache.tomcat.util.digester.SetRootRule
SetRootRule | public class SetRootRule extends Rule (Code) | | Rule implementation that calls a method on the root object on the stack,
passing the top object (child) as an argument.
It is important to remember that this rule acts on end .
This rule now supports more flexible method matching by default.
It is possible that this may break (some) code
written against release 1.1.1 or earlier.
See
SetRootRule.isExactMatch() for more details.
|
Field Summary | |
protected String | methodName The method name to call on the parent object. | protected String | paramType The Java class name of the parameter type expected by the method. | protected boolean | useExactMatch Should we use exact matching. |
Constructor Summary | |
public | SetRootRule(Digester digester, String methodName) Construct a "set root" rule with the specified method name. | public | SetRootRule(Digester digester, String methodName, String paramType) Construct a "set root" rule with the specified method name. | public | SetRootRule(String methodName) Construct a "set root" rule with the specified method name. | public | SetRootRule(String methodName, String paramType) Construct a "set root" rule with the specified method name. |
Method Summary | |
public void | end() Process the end of this element. | public boolean | isExactMatch() Is exact matching being used.
This rule uses org.apache.commons.beanutils.MethodUtils
to introspect the relevent objects so that the right method can be called. | public void | setExactMatch(boolean useExactMatch) | public String | toString() Render a printable version of this Rule. |
methodName | protected String methodName(Code) | | The method name to call on the parent object.
|
paramType | protected String paramType(Code) | | The Java class name of the parameter type expected by the method.
|
useExactMatch | protected boolean useExactMatch(Code) | | Should we use exact matching. Default is no.
|
SetRootRule | public SetRootRule(Digester digester, String methodName, String paramType)(Code) | | Construct a "set root" rule with the specified method name.
Parameters: digester - The associated Digester Parameters: methodName - Method name of the parent method to call Parameters: paramType - Java class of the parent method's argument(if you wish to use a primitive type, specify the corresondingJava wrapper class instead, such as java.lang.Boolean for a boolean parameter)Digester.addRuleSetRootRule.SetRootRule(String methodName,String paramType) |
SetRootRule | public SetRootRule(String methodName)(Code) | | Construct a "set root" rule with the specified method name. The
method's argument type is assumed to be the class of the
child object.
Parameters: methodName - Method name of the parent method to call |
SetRootRule | public SetRootRule(String methodName, String paramType)(Code) | | Construct a "set root" rule with the specified method name.
Parameters: methodName - Method name of the parent method to call Parameters: paramType - Java class of the parent method's argument(if you wish to use a primitive type, specify the corresondingJava wrapper class instead, such as java.lang.Boolean for a boolean parameter) |
end | public void end() throws Exception(Code) | | Process the end of this element.
|
isExactMatch | public boolean isExactMatch()(Code) | | Is exact matching being used.
This rule uses org.apache.commons.beanutils.MethodUtils
to introspect the relevent objects so that the right method can be called.
Originally, MethodUtils.invokeExactMethod was used.
This matches methods very strictly
and so may not find a matching method when one exists.
This is still the behaviour when exact matching is enabled.
When exact matching is disabled, MethodUtils.invokeMethod is used.
This method finds more methods but is less precise when there are several methods
with correct signatures.
So, if you want to choose an exact signature you might need to enable this property.
The default setting is to disable exact matches.
true iff exact matching is enabled since: Digester Release 1.1.1 |
setExactMatch | public void setExactMatch(boolean useExactMatch)(Code) | | Set whether exact matching is enabled.
See
SetRootRule.isExactMatch() .
Parameters: useExactMatch - should this rule use exact method matching since: Digester Release 1.1.1 |
toString | public String toString()(Code) | | Render a printable version of this Rule.
|
|
|