public final class LinkedRuleBuilder extends Object
Modifier and Type | Method and Description |
---|---|
<R extends Rule> |
addRule(R rule)
Add a custom user rule in the specified pattern.
|
<R extends Rule> |
addRuleCreatedBy(RuleProvider<R> provider)
Add a custom user rule in the specified pattern built by the given provider.
|
CallMethodBuilder |
callMethod(String methodName)
Calls a method on an object on the stack (normally the top/parent object), passing arguments collected from
subsequent
callParam() rule or from the body of this element. |
CallParamBuilder |
callParam()
Saves a parameter for use by a surrounding
callMethod(String) . |
PathCallParamBuilder |
callParamPath()
Construct a "call parameter" rule that will save the body text of this element as the parameter value.
|
NodeCreateRuleProvider |
createNode()
A rule implementation that creates a DOM Node containing the XML at the element that matched the rule.
|
ObjectCreateBuilder |
createObject()
Construct an object.
|
PluginCreateRuleBuilder |
createPlugin()
A Digester rule which allows the user to declare a plugin.
|
PluginDeclarationRuleBuilder |
declarePlugin()
A Digester rule which allows the user to pre-declare a class which is to
be referenced later at a plugin point by a PluginCreateRule.
|
FactoryCreateBuilder |
factoryCreate()
Uses an
ObjectCreationFactory to create a new object which it
pushes onto the object stack. |
<T> ObjectParamBuilder<T> |
objectParam(T paramObj)
Saves a parameter for use by a surrounding
callMethod(String) . |
BeanPropertySetterBuilder |
setBeanProperty()
Construct rule that automatically sets a property from the body text, taking the property
name the same as the current element.
|
NestedPropertiesBuilder |
setNestedProperties()
Sets properties on the object at the top of the stack,
based on child elements with names matching properties on that object.
|
SetNextBuilder |
setNext(String methodName)
Calls a method on the (top-1) (parent) object, passing the top object (child) as an argument,
commonly used to establish parent-child relationships.
|
SetPropertiesBuilder |
setProperties()
Sets properties on the object at the top of the stack, based on attributes with corresponding names.
|
SetPropertyBuilder |
setProperty(String attributePropertyName)
Sets an individual property on the object at the top of the stack, based on attributes with specified names.
|
SetRootBuilder |
setRoot(String methodName)
Calls a method on the root object on the stack, passing the top object (child) as an argument.
|
SetTopBuilder |
setTop(String methodName)
Calls a "set top" method on the top (child) object, passing the (top-1) (parent) object as an argument.
|
LinkedRuleBuilder |
withNamespaceURI(String namespaceURI)
Sets the namespace URI for the current rule pattern.
|
public BeanPropertySetterBuilder setBeanProperty()
BeanPropertySetterBuilder
instance.public CallMethodBuilder callMethod(String methodName)
callParam()
rule or from the body of this element.methodName
- Method name of the parent object to callCallMethodBuilder
instance.public CallParamBuilder callParam()
callMethod(String)
.CallParamBuilder
instance.public PathCallParamBuilder callParamPath()
PathCallParamBuilder
instance.public FactoryCreateBuilder factoryCreate()
ObjectCreationFactory
to create a new object which it
pushes onto the object stack.
When the element is complete, the object will be popped.FactoryCreateBuilder
instance.public ObjectCreateBuilder createObject()
ObjectCreateBuilder
instance.public <T> ObjectParamBuilder<T> objectParam(T paramObj)
callMethod(String)
.T
- The parameter type to pass alongparamObj
- The parameter to pass alongObjectParamBuilder
instance.public NestedPropertiesBuilder setNestedProperties()
NestedPropertiesBuilder
instance.public SetNextBuilder setNext(String methodName)
methodName
- Method name of the parent method to callSetNextBuilder
instance.public SetPropertiesBuilder setProperties()
SetPropertiesBuilder
instance.public SetPropertyBuilder setProperty(String attributePropertyName)
attributePropertyName
- Name of the attribute that will contain the name of the property to be setSetPropertyBuilder
instance.public SetRootBuilder setRoot(String methodName)
methodName
- Method name of the parent method to callSetRootBuilder
instance.public SetTopBuilder setTop(String methodName)
methodName
- Method name of the "set parent" method to callSetTopBuilder
instance.public PluginDeclarationRuleBuilder declarePlugin()
Digester
instances
will be created using PluginRules
rules strategy.PluginDeclarationRuleBuilder
instance.public PluginCreateRuleBuilder createPlugin()
Digester
instances
will be created using PluginRules
rules strategy.PluginDeclarationRuleBuilder
instance.public NodeCreateRuleProvider createNode()
NodeCreateRuleProvider
instance.public <R extends Rule> ByRuleBuilder<R> addRule(R rule)
Rule
instance is plugged to more than one Digester;
use addRuleCreatedBy(RuleProvider)
instead!!!R
- The rule typerule
- The custom user ruleByRuleBuilder
instance.addRuleCreatedBy(RuleProvider)
,
Rule.setDigester(org.apache.commons.digester3.Digester)
public <R extends Rule> ByRuleProviderBuilder<R> addRuleCreatedBy(RuleProvider<R> provider)
R
- The rule typeprovider
- The rule providerByRuleProviderBuilder
instance.public LinkedRuleBuilder withNamespaceURI(String namespaceURI)
namespaceURI
- the namespace URI associated to the rule pattern.LinkedRuleBuilder
instanceCopyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.