| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tomcat.util.digester.Rule
org.apache.tomcat.util.digester.SetTopRule
public class SetTopRule
Rule implementation that calls a "set parent" method on the top (child) object, passing the (top-1) (parent) object as an argument.
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 isExactMatch() for more details.
| Field Summary | |
|---|---|
| protected  java.lang.String | methodNameThe method name to call on the child object. | 
| protected  java.lang.String | paramTypeThe Java class name of the parameter type expected by the method. | 
| protected  boolean | useExactMatchShould we use exact matching. | 
| Fields inherited from class org.apache.tomcat.util.digester.Rule | 
|---|
| digester, namespaceURI | 
| Constructor Summary | |
|---|---|
| SetTopRule(Digester digester,
           java.lang.String methodName)Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule)method. 
 UseSetTopRule(String methodName)instead. | |
| SetTopRule(Digester digester,
           java.lang.String methodName,
           java.lang.String paramType)Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule)method. 
 UseSetTopRule(String methodName, String paramType)instead. | |
| SetTopRule(java.lang.String methodName)Construct a "set parent" rule with the specified method name. | |
| SetTopRule(java.lang.String methodName,
           java.lang.String paramType)Construct a "set parent" rule with the specified method name. | |
| Method Summary | |
|---|---|
|  void | end()Process the end of this element. | 
|  boolean | isExactMatch()Is exact matching being used. | 
|  void | setExactMatch(boolean useExactMatch)Set whether exact matching is enabled. | 
|  java.lang.String | toString()Render a printable version of this Rule. | 
| Methods inherited from class org.apache.tomcat.util.digester.Rule | 
|---|
| begin, begin, body, body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Field Detail | 
|---|
protected java.lang.String methodName
protected java.lang.String paramType
protected boolean useExactMatch
| Constructor Detail | 
|---|
public SetTopRule(Digester digester,
                  java.lang.String methodName)
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule) method. 
 Use SetTopRule(String methodName) instead.
digester - The associated DigestermethodName - Method name of the "set parent" method to call
public SetTopRule(Digester digester,
                  java.lang.String methodName,
                  java.lang.String paramType)
Digester.addRule(java.lang.String, org.apache.tomcat.util.digester.Rule) method. 
 Use SetTopRule(String methodName, String paramType) instead.
digester - The associated DigestermethodName - Method name of the "set parent" method to callparamType - Java class of the "set parent" method's argument
  (if you wish to use a primitive type, specify the corresonding
  Java wrapper class instead, such as java.lang.Boolean
  for a boolean parameter)public SetTopRule(java.lang.String methodName)
methodName - Method name of the "set parent" method to call
public SetTopRule(java.lang.String methodName,
                  java.lang.String paramType)
methodName - Method name of the "set parent" method to callparamType - Java class of the "set parent" method's argument
  (if you wish to use a primitive type, specify the corresonding
  Java wrapper class instead, such as java.lang.Boolean
  for a boolean parameter)| Method Detail | 
|---|
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.
 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.
public void setExactMatch(boolean useExactMatch)
Set whether exact matching is enabled.
See isExactMatch().
useExactMatch - should this rule use exact method matching
public void end()
         throws java.lang.Exception
end in class Rulejava.lang.Exceptionpublic java.lang.String toString()
toString in class java.lang.Object| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||