Class CounterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.data.change.counter.rev160315.data.change.counter.CounterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Counter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Counter,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class CounterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Counter>
Class that buildsCounter
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:
Counter createCounter(int fooXyzzy, int barBaz) { return new CounterBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Counter, 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:
Counter
,Builder
-
-
Constructor Summary
Constructors Constructor Description CounterBuilder()
CounterBuilder(Counter base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CounterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Counter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>>
E$$augmentation(Class<E$$> augmentationType)
Counter
build()
org.opendaylight.yangtools.yang.common.Uint32
getCount()
String
getId()
CounterKey
key()
CounterBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>> augmentationType)
Remove an augmentation from this builder's product.CounterBuilder
setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
CounterBuilder
setId(String value)
CounterBuilder
withKey(CounterKey key)
-
-
-
Constructor Detail
-
CounterBuilder
public CounterBuilder()
-
CounterBuilder
public CounterBuilder(Counter base)
-
-
Method Detail
-
key
public CounterKey key()
-
getCount
public org.opendaylight.yangtools.yang.common.Uint32 getCount()
-
getId
public String getId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public CounterBuilder withKey(CounterKey key)
-
setCount
public CounterBuilder setCount(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setId
public CounterBuilder setId(String value)
-
addAugmentation
public CounterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Counter> 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 CounterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>> 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 Counter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Counter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Counter,IllegalArgumentException>
-
-