Class NxmOfEthTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.eth.type.grouping.NxmOfEthTypeBuilder
-
@Generated("mdsal-binding-generator") public class NxmOfEthTypeBuilder extends Object
Class that buildsNxmOfEthType
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:
NxmOfEthType createNxmOfEthType(int fooXyzzy, int barBaz) { return new NxmOfEthTypeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmOfEthType, 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 opportunities, 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:
NxmOfEthType
- 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
-
-
Constructor Summary
Constructors Constructor Description NxmOfEthTypeBuilder()
Construct an empty builder.NxmOfEthTypeBuilder(NxmOfEthType base)
Construct a builder initialized with state from specifiedNxmOfEthType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxmOfEthTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NxmOfEthType
build()
A newNxmOfEthType
instance.org.opendaylight.yangtools.yang.common.Uint16
getValue()
Return current value associated with the property corresponding toNxmOfEthType.getValue()
.NxmOfEthTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>> augmentationType)
Remove an augmentation from this builder's product.NxmOfEthTypeBuilder
setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxmOfEthType.getValue()
to the specified value.
-
-
-
Constructor Detail
-
NxmOfEthTypeBuilder
public NxmOfEthTypeBuilder()
Construct an empty builder.
-
NxmOfEthTypeBuilder
public NxmOfEthTypeBuilder(NxmOfEthType base)
Construct a builder initialized with state from specifiedNxmOfEthType
.- Parameters:
base
- NxmOfEthType from which the builder should be initialized
-
-
Method Detail
-
getValue
public org.opendaylight.yangtools.yang.common.Uint16 getValue()
Return current value associated with the property corresponding toNxmOfEthType.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setValue
public NxmOfEthTypeBuilder setValue(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toNxmOfEthType.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxmOfEthTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType> 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 NxmOfEthTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>> 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 @NonNull NxmOfEthType build()
A newNxmOfEthType
instance.- Returns:
- A new
NxmOfEthType
instance.
-
-