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