Class DataChangeCounterConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgpcep.data.change.counter.config.rev170424.DataChangeCounterConfigBuilder
-
@Generated("mdsal-binding-generator") public class DataChangeCounterConfigBuilder extends Object
Class that buildsDataChangeCounterConfig
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:
DataChangeCounterConfig
- 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
-
-
Constructor Summary
Constructors Constructor Description DataChangeCounterConfigBuilder()
Construct an empty builder.DataChangeCounterConfigBuilder(DataChangeCounterConfig base)
Construct a builder initialized with state from specifiedDataChangeCounterConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataChangeCounterConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounterConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounterConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DataChangeCounterConfig
build()
A newDataChangeCounterConfig
instance.String
getCounterId()
Return current value associated with the property corresponding toDataChangeCounterConfig.getCounterId()
.String
getTopologyName()
Return current value associated with the property corresponding toDataChangeCounterConfig.getTopologyName()
.DataChangeCounterConfigKey
key()
Return current value associated with the property corresponding toDataChangeCounterConfig.key()
.DataChangeCounterConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounterConfig>> augmentationType)
Remove an augmentation from this builder's product.DataChangeCounterConfigBuilder
setCounterId(String value)
Set the property corresponding toDataChangeCounterConfig.getCounterId()
to the specified value.DataChangeCounterConfigBuilder
setTopologyName(String value)
Set the property corresponding toDataChangeCounterConfig.getTopologyName()
to the specified value.DataChangeCounterConfigBuilder
withKey(DataChangeCounterConfigKey key)
-
-
-
Constructor Detail
-
DataChangeCounterConfigBuilder
public DataChangeCounterConfigBuilder()
Construct an empty builder.
-
DataChangeCounterConfigBuilder
public DataChangeCounterConfigBuilder(DataChangeCounterConfig base)
Construct a builder initialized with state from specifiedDataChangeCounterConfig
.- Parameters:
base
- DataChangeCounterConfig from which the builder should be initialized
-
-
Method Detail
-
key
public DataChangeCounterConfigKey key()
Return current value associated with the property corresponding toDataChangeCounterConfig.key()
.- Returns:
- current value
-
getCounterId
public String getCounterId()
Return current value associated with the property corresponding toDataChangeCounterConfig.getCounterId()
.- Returns:
- current value
-
getTopologyName
public String getTopologyName()
Return current value associated with the property corresponding toDataChangeCounterConfig.getTopologyName()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounterConfig>> 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
-
withKey
public DataChangeCounterConfigBuilder withKey(DataChangeCounterConfigKey key)
-
setCounterId
public DataChangeCounterConfigBuilder setCounterId(String value)
Set the property corresponding toDataChangeCounterConfig.getCounterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTopologyName
public DataChangeCounterConfigBuilder setTopologyName(String value)
Set the property corresponding toDataChangeCounterConfig.getTopologyName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DataChangeCounterConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounterConfig> 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 DataChangeCounterConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounterConfig>> 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
public @NonNull DataChangeCounterConfig build()
A newDataChangeCounterConfig
instance.- Returns:
- A new
DataChangeCounterConfig
instance.
-
-