Class NshFlagsValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.nxm.nx.match.nsh.flags.grouping.NshFlagsValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NshFlagsValues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NshFlagsValues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NshFlagsValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NshFlagsValues>
Class that buildsNshFlagsValuesBuilder
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:
NshFlagsValuesBuilder createTarget(int fooXyzzy, int barBaz) { return new NshFlagsValuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NshFlagsValuesBuilder, 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:
NshFlagsValuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NshFlagsValuesBuilder()
NshFlagsValuesBuilder(NshFlagsValues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NshFlagsValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsValues>>
E$$augmentation(Class<E$$> augmentationType)
NshFlagsValues
build()
org.opendaylight.yangtools.yang.common.Uint8
getMask()
org.opendaylight.yangtools.yang.common.Uint8
getNshFlags()
NshFlagsValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsValues>> augmentationType)
Remove an augmentation from this builder's product.NshFlagsValuesBuilder
setMask(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMask(Uint8)
instead.NshFlagsValuesBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint8 value)
NshFlagsValuesBuilder
setNshFlags(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNshFlags(Uint8)
instead.NshFlagsValuesBuilder
setNshFlags(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
NshFlagsValuesBuilder
public NshFlagsValuesBuilder()
-
NshFlagsValuesBuilder
public NshFlagsValuesBuilder(NshFlagsValues base)
-
-
Method Detail
-
getMask
public org.opendaylight.yangtools.yang.common.Uint8 getMask()
-
getNshFlags
public org.opendaylight.yangtools.yang.common.Uint8 getNshFlags()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsValues>> E$$ augmentation(Class<E$$> augmentationType)
-
setMask
public NshFlagsValuesBuilder setMask(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMask
@Deprecated(forRemoval=true) public NshFlagsValuesBuilder setMask(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMask(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setNshFlags
public NshFlagsValuesBuilder setNshFlags(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setNshFlags
@Deprecated(forRemoval=true) public NshFlagsValuesBuilder setNshFlags(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNshFlags(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NshFlagsValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsValues> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public NshFlagsValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NshFlagsValues>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public NshFlagsValues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NshFlagsValues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NshFlagsValues,IllegalArgumentException>
-
-