Top Description Fields Constructors Methods
org.apache.tomcat.util.digester

public Class SetNextRule

extends Rule
Class Inheritance
Imports
org.apache.tomcat.util.IntrospectionUtils

Rule implementation that calls a method on the (top-1) (parent) object, passing the top object (child) as an argument. It is commonly used to establish parent-child relationships.

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

Modifier and TypeField and Description
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.

Inherited from org.apache.tomcat.util.digester.Rule:
digesternamespaceURIsm

Constructor Summary

AccessConstructor and Description
public
SetNextRule(String
Method name of the parent method to call
methodName, String
Java class of the 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)
paramType)

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

Method Summary

Modifier and TypeMethod and Description
public void
end(String
the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
namespace, String
the local name if the parser is namespace aware, or just the element name otherwise
name)

Overrides org.apache.tomcat.util.digester.Rule.end.

Process the end of this element.

public boolean

Returns:

true iff exact matching is enabled
isExactMatch()

Is exact matching being used.

public void
setExactMatch(boolean
should this rule use exact method matching
useExactMatch)

Set whether exact matching is enabled.

public String
toString()

Overrides java.lang.Object.toString.

Render a printable version of this Rule.

Inherited from org.apache.tomcat.util.digester.Rule:
beginbodyfinishgetDigestergetNamespaceURIsetDigestersetNamespaceURI

Field Detail

methodNameback to summary
protected String methodName

The method name to call on the parent object.

paramTypeback to summary
protected String paramType

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

useExactMatchback to summary
protected boolean useExactMatch

Should we use exact matching. Default is no.

Constructor Detail

SetNextRuleback to summary
public SetNextRule(String methodName, String paramType)

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

Parameters
methodName:String

Method name of the parent method to call

paramType:String

Java class of the 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

endback to summary
public void end(String namespace, String name) throws Exception

Overrides org.apache.tomcat.util.digester.Rule.end.

Process the end of this element.

Parameters
namespace:String

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:String

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

Annotations
@Override
Exceptions
Exception:

Doc from org.apache.tomcat.util.digester.Rule.end.

if an error occurs while processing the event

isExactMatchback to summary
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:boolean

true iff exact matching is enabled

Since
Digester Release 1.1.1
setExactMatchback to summary
public void setExactMatch(boolean useExactMatch)

Set whether exact matching is enabled.

See isExactMatch().

Parameters
useExactMatch:boolean

should this rule use exact method matching

Since
Digester Release 1.1.1
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Render a printable version of this Rule.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override