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>
public class CounterBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Counter>
Class that buildsCounterBuilder
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:
CounterBuilder createTarget(int fooXyzzy, int barBaz) { return new CounterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of CounterBuilder, 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 oportunities, 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:
CounterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description CounterBuilder()
CounterBuilder(Counter base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description CounterBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Counter> augmentationValue)
<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)
CounterBuilder
setCount(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCount(Uint32)} instead.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)
-
setCount
@Deprecated(forRemoval=true) public CounterBuilder setCount(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCount(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setId
public CounterBuilder setId(String value)
-
addAugmentation
public CounterBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Counter> augmentationValue)
-
removeAugmentation
public CounterBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Counter>> augmentationType)
-
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>
-
-