Field Detail

• bodyText

  protected java.lang.String bodyText

  The body text collected from this element.

• targetOffset

  protected 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.

• methodName

  protected java.lang.String methodName

  The method name to call on the parent object.

• 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 java.lang.Class<?>[] paramTypes

  The parameter types of the parameters to be collected.

• paramClassNames

  protected java.lang.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.

• useExactMatch

  protected boolean useExactMatch

  Should MethodUtils.invokeExactMethod be used for reflection.

Constructor Detail

• CallMethodRule

  public CallMethodRule(java.lang.String methodName,
                int paramCount)

  Construct a "call method" rule with the specified method name. The parameter types (if any) default to java.lang.String.

  Parameters:

  methodName - Method name of the parent method to call

  paramCount - The number of parameters to collect, or zero for a single argument from the body of this element.

• CallMethodRule

  public CallMethodRule(int targetOffset,
                java.lang.String methodName,
                int paramCount)

  Construct a "call method" rule with the specified method name. The parameter types (if any) default to java.lang.String.

  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

  paramCount - The number of parameters to collect, or zero for a single argument from the body of this element.

• CallMethodRule

  public CallMethodRule(java.lang.String methodName)

  Construct a "call method" rule with the specified method name. The method should accept no parameters.

  Parameters:

  methodName - Method name of the parent method to call

• CallMethodRule

  public CallMethodRule(int targetOffset,
                java.lang.String methodName)

  Construct a "call method" rule with the specified method name. The method should accept no parameters.

  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(java.lang.String methodName,
                int paramCount,
                java.lang.String[] 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.

  Parameters:

  methodName - Method name of the parent method to call

  paramCount - The number of parameters to collect, or zero for a single argument from the body of this element

  paramTypes - The Java class names of the arguments (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as java.lang.Boolean for a boolean parameter)

• CallMethodRule

  public CallMethodRule(int targetOffset,
                java.lang.String methodName,
                int paramCount,
                java.lang.String[] 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.

  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

  paramCount - The number of parameters to collect, or zero for a single argument from the body of this element

  paramTypes - The Java class names of the arguments (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as java.lang.Boolean for a boolean parameter)

• CallMethodRule

  public CallMethodRule(java.lang.String methodName,
                int paramCount,
                java.lang.Class<?>[] 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.

  Parameters:

  methodName - Method name of the parent method to call

  paramCount - The number of parameters to collect, or zero for a single argument from the body of this element

  paramTypes - The Java classes that represent the parameter types of the method arguments (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as java.lang.Boolean.TYPE for a boolean parameter)

• CallMethodRule

  public CallMethodRule(int targetOffset,
                java.lang.String methodName,
                int paramCount,
                java.lang.Class<?>[] 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.

  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

  paramCount - The number of parameters to collect, or zero for a single argument from the body of this element

  paramTypes - The Java classes that represent the parameter types of the method arguments (if you wish to use a primitive type, specify the corresponding Java wrapper class instead, such as java.lang.Boolean.TYPE for a boolean parameter)

Method Detail

• getUseExactMatch

  public boolean getUseExactMatch()

  Should MethodUtils.invokeExactMethod be used for the reflection.

• setUseExactMatch

  public void setUseExactMatch(boolean useExactMatch)

  Set whether MethodUtils.invokeExactMethod should be used for the reflection.

• setDigester

  public void setDigester(Digester digester)

  Set the associated digester. If needed, this class loads the parameter classes from their names.

  Overrides:

  setDigester in class Rule

• begin

  public void begin(java.lang.String namespace,
           java.lang.String name,
           org.xml.sax.Attributes attributes)
             throws java.lang.Exception

  Process the start of this element.

  Overrides:

  begin 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

  attributes - The attribute list for this element

  Throws:

  java.lang.Exception

• body

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

  Process the body text of this element.

  Overrides:

  body 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

  bodyText - The body text of this element

  Throws:

  java.lang.Exception

• 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

• finish

  public void finish()
              throws java.lang.Exception

  Clean up after parsing is complete.

  Overrides:

  finish in class Rule

  Throws:

  java.lang.Exception

• processMethodCallResult

  protected void processMethodCallResult(java.lang.Object result)

  Subclasses may override this method to perform additional processing of the invoked method's result.

  Parameters:

  result - the Object returned by the method invoked, possibly null

• toString

  public java.lang.String toString()

  Render a printable version of this Rule.

  Overrides:

  toString in class java.lang.Object