Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.data.change.counter.rev160315
Class DataChangeCounterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.data.change.counter.rev160315.DataChangeCounterBuilder
-
@Generated("mdsal-binding-generator") public class DataChangeCounterBuilder extends Object
Class that buildsDataChangeCounter
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:
DataChangeCounter createDataChangeCounter(int fooXyzzy, int barBaz) { return new DataChangeCounterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DataChangeCounter, 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:
DataChangeCounter
- 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 DataChangeCounterBuilder()
Construct an empty builder.DataChangeCounterBuilder(DataChangeCounter base)
Construct a builder initialized with state from specifiedDataChangeCounter
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataChangeCounterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounter>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DataChangeCounter
build()
A newDataChangeCounter
instance.Map<CounterKey,Counter>
getCounter()
Return current value associated with the property corresponding toDataChangeCounter.getCounter()
.DataChangeCounterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounter>> augmentationType)
Remove an augmentation from this builder's product.DataChangeCounterBuilder
setCounter(Map<CounterKey,Counter> values)
Set the property corresponding toDataChangeCounter.getCounter()
to the specified value.
-
-
-
Constructor Detail
-
DataChangeCounterBuilder
public DataChangeCounterBuilder()
Construct an empty builder.
-
DataChangeCounterBuilder
public DataChangeCounterBuilder(DataChangeCounter base)
Construct a builder initialized with state from specifiedDataChangeCounter
.- Parameters:
base
- DataChangeCounter from which the builder should be initialized
-
-
Method Detail
-
getCounter
public Map<CounterKey,Counter> getCounter()
Return current value associated with the property corresponding toDataChangeCounter.getCounter()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounter>> 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
-
setCounter
public DataChangeCounterBuilder setCounter(Map<CounterKey,Counter> values)
Set the property corresponding toDataChangeCounter.getCounter()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public DataChangeCounterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounter> 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 DataChangeCounterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DataChangeCounter>> 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 DataChangeCounter build()
A newDataChangeCounter
instance.- Returns:
- A new
DataChangeCounter
instance.
-
-