Class AbstractParamTypeBuilder<R extends AbstractMethodRule>

java.lang.Object

org.apache.commons.digester3.binder.AbstractBackToLinkedRuleBuilder<R>

org.apache.commons.digester3.binder.AbstractParamTypeBuilder<R>

Type Parameters:

R - any AbstractMethodRule concrete implementation, typically SetNextRule, SetRootRule and SetTopRule

All Implemented Interfaces:

RuleProvider<R>

Direct Known Subclasses:

SetNextBuilder, SetRootBuilder, SetTopBuilder

public abstract class AbstractParamTypeBuilder<R extends AbstractMethodRule>
extends AbstractBackToLinkedRuleBuilder<R>

Builder chained when invoking LinkedRuleBuilder.setNext(String), LinkedRuleBuilder.setRoot(String) or LinkedRuleBuilder.setTop(String).

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
private final ClassLoader	classLoader
private boolean	fireOnBegin
private final String	methodName
private Class<?>	paramType
private boolean	useExactMatch

Constructor Summary

Constructors

Constructor	Description
AbstractParamTypeBuilder(String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder, String methodName, ClassLoader classLoader)

Method Summary

Modifier and Type	Method	Description
final AbstractParamTypeBuilder<R>	fireOnBegin(boolean fireOnBegin)	Marks the rule be invoked when begin or end events match.
(package private) final String	getMethodName()
(package private) final Class<?>	getParamType()
(package private) final boolean	isFireOnBegin()
(package private) final boolean	isUseExactMatch()
final AbstractParamTypeBuilder<R>	useExactMatch(boolean useExactMatch)	Sets exact matching being used.
final AbstractParamTypeBuilder<R>	withParameterType(Class<?> paramType)	Sets the Java class of the method's argument.
final AbstractParamTypeBuilder<R>	withParameterType(String paramType)	Sets the Java class name of the method's argument.

Methods inherited from class AbstractBackToLinkedRuleBuilder

createRule, get, getNamespaceURI, getPattern, reportError, then

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

methodName

private final String methodName

classLoader

private final ClassLoader classLoader

useExactMatch

private boolean useExactMatch

paramType

private Class<?> paramType

fireOnBegin

private boolean fireOnBegin

Constructor Details

AbstractParamTypeBuilder

AbstractParamTypeBuilder(String keyPattern,
 String namespaceURI,
 RulesBinder mainBinder,
 LinkedRuleBuilder mainBuilder,
 String methodName,
 ClassLoader classLoader)

Method Details

withParameterType

public final AbstractParamTypeBuilder<R> withParameterType(Class<?> paramType)

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

Parameters:

paramType - The Java class of the method's argument

Returns:

this builder instance

withParameterType

public final AbstractParamTypeBuilder<R> withParameterType(String paramType)

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

Parameters:

paramType - The Java class name of the method's argument

Returns:

this builder instance

useExactMatch

public final AbstractParamTypeBuilder<R> useExactMatch(boolean useExactMatch)

Sets exact matching being used.

Parameters:

useExactMatch - The exact matching being used

Returns:

this builder instance

fireOnBegin

public final AbstractParamTypeBuilder<R> fireOnBegin(boolean fireOnBegin)

Marks the rule be invoked when begin or end events match.

Parameters:

fireOnBegin - true, to invoke the rule at begin, false for end

Returns:

this builder instance

getMethodName

final String getMethodName()

getParamType

final Class<?> getParamType()

isUseExactMatch

final boolean isUseExactMatch()

isFireOnBegin

final boolean isFireOnBegin()