Class NxmNxTunIdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.tun.id.grouping.NxmNxTunIdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxmNxTunId>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxTunId,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxmNxTunIdBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxmNxTunId>
Class that buildsNxmNxTunId
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:
NxmNxTunId createNxmNxTunId(int fooXyzzy, int barBaz) { return new NxmNxTunIdBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmNxTunId, 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:
NxmNxTunId
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxmNxTunIdBuilder()
NxmNxTunIdBuilder(NxmNxTunId base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxmNxTunIdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunId> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunId>>
E$$augmentation(Class<E$$> augmentationType)
NxmNxTunId
build()
org.opendaylight.yangtools.yang.common.Uint64
getValue()
NxmNxTunIdBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunId>> augmentationType)
Remove an augmentation from this builder's product.NxmNxTunIdBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
NxmNxTunIdBuilder
public NxmNxTunIdBuilder()
-
NxmNxTunIdBuilder
public NxmNxTunIdBuilder(NxmNxTunId base)
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint64 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunId>> E$$ augmentation(Class<E$$> augmentationType)
-
setValue
public NxmNxTunIdBuilder setValue(org.opendaylight.yangtools.yang.common.Uint64 value)
-
addAugmentation
public NxmNxTunIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunId> 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 NxmNxTunIdBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxTunId>> 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 NxmNxTunId build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxmNxTunId>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxTunId,IllegalArgumentException>
-
-