Package org.apache.commons.digester3.binder

Class ObjectParamBuilder<T>

java.lang.Object

org.apache.commons.digester3.binder.ObjectParamBuilder<T>

Type Parameters:

T - The object type represented by this builder

All Implemented Interfaces:

RuleProvider<ObjectParamRule>

public final class ObjectParamBuilder<T>
extends java.lang.Object

Builder chained when invoking LinkedRuleBuilder.objectParam(Object).

Since:

3.0

Method Summary

Modifier and Type	Method	Description
protected ObjectParamRule	createRule()	Provides an instance of Rule.
R	get()	Provides an instance of Rule.
java.lang.String	getNamespaceURI()	Returns the namespace URI for which this Rule is relevant, if any.
java.lang.String	getPattern()	Returns the rule pattern associated to this builder.
ObjectParamBuilder<T>	matchingAttribute(java.lang.String attributeName)	The attribute which we are attempting to match.
ObjectParamBuilder<T>	ofIndex(int paramIndex)	The zero-relative index of the parameter we are saving.
protected void	reportError(java.lang.String methodChain, java.lang.String message)
LinkedRuleBuilder	then()	Come back to the main LinkedRuleBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

ofIndex

public ObjectParamBuilder<T> ofIndex(int paramIndex)

The zero-relative index of the parameter we are saving.

Parameters:

paramIndex - The zero-relative index of the parameter we are saving

Returns:

this builder instance

matchingAttribute

public ObjectParamBuilder<T> matchingAttribute(java.lang.String attributeName)

The attribute which we are attempting to match.

Parameters:

attributeName - The attribute which we are attempting to match

Returns:

this builder instance

createRule

protected ObjectParamRule createRule()

Provides an instance of Rule. Must never return null.

Returns:

an instance of Rule.

See Also:

RuleProvider.get()

then

public final LinkedRuleBuilder then()

Come back to the main LinkedRuleBuilder.

Returns:

the main LinkedRuleBuilder

getNamespaceURI

public final java.lang.String getNamespaceURI()

Returns the namespace URI for which this Rule is relevant, if any.

Returns:

The namespace URI for which this Rule is relevant, if any

get

public final R get()

Provides an instance of Rule. Must never return null.

Specified by:

get in interface RuleProvider<R extends Rule>

Returns:

an instance of Rule.

reportError

protected final void reportError(java.lang.String methodChain,
                                 java.lang.String message)

getPattern

public final java.lang.String getPattern()

Returns the rule pattern associated to this builder.

Returns:

The rule pattern associated to this builder