Class CallParamBuilder
- java.lang.Object
-
- org.apache.commons.digester3.binder.AbstractBackToLinkedRuleBuilder<CallParamRule>
-
- org.apache.commons.digester3.binder.CallParamBuilder
-
- All Implemented Interfaces:
RuleProvider<CallParamRule>
public final class CallParamBuilder extends AbstractBackToLinkedRuleBuilder<CallParamRule>
Builder chained when invokingLinkedRuleBuilder.callParam()
.- Since:
- 3.0
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
attributeName
private boolean
fromStack
private int
paramIndex
private int
stackIndex
-
Constructor Summary
Constructors Constructor Description CallParamBuilder(java.lang.String keyPattern, java.lang.String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CallParamRule
createRule()
Provides an instance ofRule
.CallParamBuilder
fromAttribute(java.lang.String attributeName)
Sets the attribute from which to save the parameter value.CallParamBuilder
fromStack(boolean fromStack)
Flags the parameter to be set from the stack.CallParamBuilder
ofIndex(int paramIndex)
Sets the zero-relative parameter number.CallParamBuilder
withStackIndex(int stackIndex)
Sets the position of the object from the top of the stack.-
Methods inherited from class org.apache.commons.digester3.binder.AbstractBackToLinkedRuleBuilder
get, getNamespaceURI, getPattern, reportError, then
-
-
-
-
Constructor Detail
-
CallParamBuilder
CallParamBuilder(java.lang.String keyPattern, java.lang.String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder)
-
-
Method Detail
-
ofIndex
public CallParamBuilder ofIndex(int paramIndex)
Sets the zero-relative parameter number.- Parameters:
paramIndex
- The zero-relative parameter number- Returns:
- this builder instance
-
fromAttribute
public CallParamBuilder fromAttribute(java.lang.String attributeName)
Sets the attribute from which to save the parameter value.- Parameters:
attributeName
- The attribute from which to save the parameter value- Returns:
- this builder instance
-
fromStack
public CallParamBuilder fromStack(boolean fromStack)
Flags the parameter to be set from the stack.- Parameters:
fromStack
- the parameter flag to be set from the stack- Returns:
- this builder instance
-
withStackIndex
public CallParamBuilder withStackIndex(int stackIndex)
Sets the position of the object from the top of the stack.- Parameters:
stackIndex
- The position of the object from the top of the stack- Returns:
- this builder instance
-
createRule
protected CallParamRule createRule()
Provides an instance ofRule
. Must never return null.- Specified by:
createRule
in classAbstractBackToLinkedRuleBuilder<CallParamRule>
- Returns:
- an instance of
Rule
. - See Also:
AbstractBackToLinkedRuleBuilder.get()
-
-