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