Class ForwardingRulesManagerConfigBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.openflowplugin.app.forwardingrules.manager.config.rev160511.ForwardingRulesManagerConfigBuilder
@Generated("mdsal-binding-generator")
public class ForwardingRulesManagerConfigBuilder
extends Object
Class that builds
ForwardingRulesManagerConfig
instances. Overall design of the class is that of a
fluent interface, where method chaining is used.
In general, this class is supposed to be used like this template:
ForwardingRulesManagerConfig createForwardingRulesManagerConfig(int fooXyzzy, int barBaz) {
return new ForwardingRulesManagerConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ForwardingRulesManagerConfig, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization opportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedForwardingRulesManagerConfig
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ForwardingRulesManagerConfig> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ForwardingRulesManagerConfig>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ForwardingRulesManagerConfig
build()
A newForwardingRulesManagerConfig
instance.Return current value associated with the property corresponding toForwardingRulesManagerConfig.getBundleBasedReconciliationEnabled()
.Return current value associated with the property corresponding toForwardingRulesManagerConfig.getDisableReconciliation()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toForwardingRulesManagerConfig.getReconciliationRetryCount()
.Return current value associated with the property corresponding toForwardingRulesManagerConfig.getStaleMarkingEnabled()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ForwardingRulesManagerConfig>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toForwardingRulesManagerConfig.getBundleBasedReconciliationEnabled()
to the specified value.setDisableReconciliation
(Boolean value) Set the property corresponding toForwardingRulesManagerConfig.getDisableReconciliation()
to the specified value.setReconciliationRetryCount
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toForwardingRulesManagerConfig.getReconciliationRetryCount()
to the specified value.setStaleMarkingEnabled
(Boolean value) Set the property corresponding toForwardingRulesManagerConfig.getStaleMarkingEnabled()
to the specified value.
-
Constructor Details
-
ForwardingRulesManagerConfigBuilder
public ForwardingRulesManagerConfigBuilder()Construct an empty builder. -
ForwardingRulesManagerConfigBuilder
Construct a builder initialized with state from specifiedForwardingRulesManagerConfig
.- Parameters:
base
- ForwardingRulesManagerConfig from which the builder should be initialized
-
-
Method Details
-
getBundleBasedReconciliationEnabled
Return current value associated with the property corresponding toForwardingRulesManagerConfig.getBundleBasedReconciliationEnabled()
.- Returns:
- current value
-
getDisableReconciliation
Return current value associated with the property corresponding toForwardingRulesManagerConfig.getDisableReconciliation()
.- Returns:
- current value
-
getReconciliationRetryCount
public org.opendaylight.yangtools.yang.common.Uint16 getReconciliationRetryCount()Return current value associated with the property corresponding toForwardingRulesManagerConfig.getReconciliationRetryCount()
.- Returns:
- current value
-
getStaleMarkingEnabled
Return current value associated with the property corresponding toForwardingRulesManagerConfig.getStaleMarkingEnabled()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ForwardingRulesManagerConfig>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBundleBasedReconciliationEnabled
Set the property corresponding toForwardingRulesManagerConfig.getBundleBasedReconciliationEnabled()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDisableReconciliation
Set the property corresponding toForwardingRulesManagerConfig.getDisableReconciliation()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReconciliationRetryCount
public ForwardingRulesManagerConfigBuilder setReconciliationRetryCount(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toForwardingRulesManagerConfig.getReconciliationRetryCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStaleMarkingEnabled
Set the property corresponding toForwardingRulesManagerConfig.getStaleMarkingEnabled()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ForwardingRulesManagerConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ForwardingRulesManagerConfig> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public ForwardingRulesManagerConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ForwardingRulesManagerConfig>> augmentationType) Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
A newForwardingRulesManagerConfig
instance.- Returns:
- A new
ForwardingRulesManagerConfig
instance.
-