Class NxmNxNshMdtypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsh.mdtype.grouping.NxmNxNshMdtypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxmNxNshMdtype>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxNshMdtype,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class NxmNxNshMdtypeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxmNxNshMdtype>
Class that buildsNxmNxNshMdtypeBuilder
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:
NxmNxNshMdtypeBuilder createTarget(int fooXyzzy, int barBaz) { return new NxmNxNshMdtypeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmNxNshMdtypeBuilder, 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:
NxmNxNshMdtypeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxmNxNshMdtypeBuilder()
NxmNxNshMdtypeBuilder(NxmNxNshMdtype base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxmNxNshMdtypeBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype>>
E$$augmentation(Class<E$$> augmentationType)
NxmNxNshMdtype
build()
org.opendaylight.yangtools.yang.common.Uint8
getValue()
NxmNxNshMdtypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype>> augmentationType)
NxmNxNshMdtypeBuilder
setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint8)} instead.NxmNxNshMdtypeBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NxmNxNshMdtypeBuilder
public NxmNxNshMdtypeBuilder()
-
NxmNxNshMdtypeBuilder
public NxmNxNshMdtypeBuilder(NxmNxNshMdtype base)
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint8 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype>> E$$ augmentation(Class<E$$> augmentationType)
-
setValue
public NxmNxNshMdtypeBuilder setValue(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
@Deprecated(forRemoval=true) public NxmNxNshMdtypeBuilder setValue(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setValue(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxmNxNshMdtypeBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype> augmentationValue)
-
removeAugmentation
public NxmNxNshMdtypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshMdtype>> augmentationType)
-
build
public NxmNxNshMdtype build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxmNxNshMdtype>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxNshMdtype,IllegalArgumentException>
-
-