Class NxActionEncapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.encap.grouping.NxActionEncapBuilder
-
@Generated("mdsal-binding-generator") public class NxActionEncapBuilder extends Object
Class that buildsNxActionEncap
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:
NxActionEncap createNxActionEncap(int fooXyzzy, int barBaz) { return new NxActionEncapBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionEncap, 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:
NxActionEncap
- 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 NxActionEncapBuilder()
Construct an empty builder.NxActionEncapBuilder(NxActionEncap base)
Construct a builder initialized with state from specifiedNxActionEncap
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxActionEncapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull NxActionEncap
build()
A newNxActionEncap
instance.ExperimenterId
getExperimenterId()
Return current value associated with the property corresponding toNxActionEncap.getExperimenterId()
.org.opendaylight.yangtools.yang.common.Uint32
getPacketType()
Return current value associated with the property corresponding toNxActionEncap.getPacketType()
.NxActionEncapBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>> augmentationType)
Remove an augmentation from this builder's product.NxActionEncapBuilder
setExperimenterId(ExperimenterId value)
Set the property corresponding toNxActionEncap.getExperimenterId()
to the specified value.NxActionEncapBuilder
setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toNxActionEncap.getPacketType()
to the specified value.
-
-
-
Constructor Detail
-
NxActionEncapBuilder
public NxActionEncapBuilder()
Construct an empty builder.
-
NxActionEncapBuilder
public NxActionEncapBuilder(NxActionEncap base)
Construct a builder initialized with state from specifiedNxActionEncap
.- Parameters:
base
- NxActionEncap from which the builder should be initialized
-
-
Method Detail
-
getExperimenterId
public ExperimenterId getExperimenterId()
Return current value associated with the property corresponding toNxActionEncap.getExperimenterId()
.- Returns:
- current value
-
getPacketType
public org.opendaylight.yangtools.yang.common.Uint32 getPacketType()
Return current value associated with the property corresponding toNxActionEncap.getPacketType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>> 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
-
setExperimenterId
public NxActionEncapBuilder setExperimenterId(ExperimenterId value)
Set the property corresponding toNxActionEncap.getExperimenterId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketType
public NxActionEncapBuilder setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toNxActionEncap.getPacketType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public NxActionEncapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap> 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 NxActionEncapBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>> 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 NxActionEncap build()
A newNxActionEncap
instance.- Returns:
- A new
NxActionEncap
instance.
-
-