Class DataChangeCounterConfigBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<DataChangeCounterConfig,DataChangeCounterConfigBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgpcep.data.change.counter.config.rev170424.DataChangeCounterConfigBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class DataChangeCounterConfigBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<DataChangeCounterConfig,DataChangeCounterConfigBuilder>
Class that builds
DataChangeCounterConfig 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:
DataChangeCounterConfig createDataChangeCounterConfig(int fooXyzzy, int barBaz) {
return new DataChangeCounterConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of DataChangeCounterConfig, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedDataChangeCounterConfig. -
Method Summary
Modifier and TypeMethodDescription@NonNull DataChangeCounterConfigbuild()Returns A newDataChangeCounterConfiginstance.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasekey()Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releasesetCounterId(String value) Set the property corresponding toDataChangeCounterConfig.getCounterId()to the specified value.setTopologyName(String value) Set the property corresponding toDataChangeCounterConfig.getTopologyName()to the specified value.Set the key value corresponding toEntryObject.key()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
DataChangeCounterConfigBuilder
public DataChangeCounterConfigBuilder()Construct an empty builder. -
DataChangeCounterConfigBuilder
Construct a builder initialized with state from specifiedDataChangeCounterConfig.- Parameters:
base- DataChangeCounterConfig from which the builder should be initialized
-
-
Method Details
-
key
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toEntryObject.key().- Returns:
- current value
-
getCounterId
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toDataChangeCounterConfig.getCounterId().- Returns:
- current value
-
getTopologyName
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toDataChangeCounterConfig.getTopologyName().- Returns:
- current value
-
withKey
Set the key value corresponding toEntryObject.key()to the specified value.- Parameters:
key- desired value- Returns:
- this builder
-
setCounterId
Set the property corresponding toDataChangeCounterConfig.getCounterId()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setTopologyName
Set the property corresponding toDataChangeCounterConfig.getTopologyName()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
Returns A newDataChangeCounterConfiginstance.- Returns:
- A new
DataChangeCounterConfiginstance
-