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