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