Field Detail

• methodName

  protected java.lang.String methodName

  The method name to call on the child object.

• paramType

  protected java.lang.String paramType

  The Java class name of the parameter type expected by the method.

• useExactMatch

  protected boolean useExactMatch

  Should we use exact matching. Default is no.

Constructor Detail

• SetTopRule

  @Deprecated
  public 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. Use SetTopRule(String methodName) instead.
  Construct a "set parent" rule with the specified method name. The "set parent" method's argument type is assumed to be the class of the parent object.

  Parameters:

  digester - The associated Digester

  methodName - Method name of the "set parent" method to call

• SetTopRule

  @Deprecated
  public 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. Use SetTopRule(String methodName, String paramType) instead.
  Construct a "set parent" rule with the specified method name.

  Parameters:

  digester - The associated Digester

  methodName - Method name of the "set parent" method to call

  paramType - Java class of the "set parent" method's argument (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as java.lang.Boolean for a boolean parameter)

• SetTopRule

  public SetTopRule(java.lang.String methodName)

  Construct a "set parent" rule with the specified method name. The "set parent" method's argument type is assumed to be the class of the parent object.

  Parameters:

  methodName - Method name of the "set parent" method to call

• SetTopRule

  public SetTopRule(java.lang.String methodName,
            java.lang.String paramType)

  Construct a "set parent" rule with the specified method name.

  Parameters:

  methodName - Method name of the "set parent" method to call

  paramType - Java class of the "set parent" method's argument (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as java.lang.Boolean for a boolean parameter)

Method Detail

• isExactMatch

  public boolean isExactMatch()

  Is exact matching being used.

  This rule uses org.apache.commons.beanutils.MethodUtils to introspect the relevant 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.

  Returns:

  true iff exact matching is enabled

  Since:

  Digester Release 1.1.1

• setExactMatch

  public void setExactMatch(boolean useExactMatch)

  Set whether exact matching is enabled.

  See isExactMatch().

  Parameters:

  useExactMatch - should this rule use exact method matching

  Since:

  Digester Release 1.1.1

• end

  public void end(java.lang.String namespace,
         java.lang.String name)
           throws java.lang.Exception

  Process the end of this element.

  Overrides:

  end in class Rule

  Parameters:

  namespace - the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace

  name - the local name if the parser is namespace aware, or just the element name otherwise

  Throws:

  java.lang.Exception

• toString

  public java.lang.String toString()

  Render a printable version of this Rule.

  Overrides:

  toString in class java.lang.Object