Class ExternalIpCounterBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.natservice.rev160111.external.ips.counter.external.counters.ExternalIpCounterBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExternalIpCounter>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExternalIpCounter,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExternalIpCounterBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ExternalIpCounter>
Class that buildsExternalIpCounterBuilder
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:
ExternalIpCounterBuilder createTarget(int fooXyzzy, int barBaz) { return new ExternalIpCounterBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExternalIpCounterBuilder, 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:
ExternalIpCounterBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExternalIpCounterBuilder()
ExternalIpCounterBuilder(ExternalIpCounter base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ExternalIpCounterBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExternalIpCounter> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalIpCounter>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ExternalIpCounter
build()
org.opendaylight.yangtools.yang.common.Uint8
getCounter()
java.lang.String
getExternalIp()
ExternalIpCounterKey
key()
ExternalIpCounterBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalIpCounter>> augmentationType)
Remove an augmentation from this builder's product.ExternalIpCounterBuilder
setCounter(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCounter(Uint8)
instead.ExternalIpCounterBuilder
setCounter(org.opendaylight.yangtools.yang.common.Uint8 value)
ExternalIpCounterBuilder
setExternalIp(java.lang.String value)
ExternalIpCounterBuilder
withKey(ExternalIpCounterKey key)
-
-
-
Constructor Detail
-
ExternalIpCounterBuilder
public ExternalIpCounterBuilder()
-
ExternalIpCounterBuilder
public ExternalIpCounterBuilder(ExternalIpCounter base)
-
-
Method Detail
-
key
public ExternalIpCounterKey key()
-
getCounter
public org.opendaylight.yangtools.yang.common.Uint8 getCounter()
-
getExternalIp
public java.lang.String getExternalIp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalIpCounter>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public ExternalIpCounterBuilder withKey(ExternalIpCounterKey key)
-
setCounter
public ExternalIpCounterBuilder setCounter(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setCounter
@Deprecated(forRemoval=true) public ExternalIpCounterBuilder setCounter(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCounter(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setExternalIp
public ExternalIpCounterBuilder setExternalIp(java.lang.String value)
-
addAugmentation
public ExternalIpCounterBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExternalIpCounter> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public ExternalIpCounterBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalIpCounter>> 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 ExternalIpCounter build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExternalIpCounter>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExternalIpCounter,java.lang.IllegalArgumentException>
-
-