Class PopVlanActionCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.action.PopVlanActionCaseBuilder
-
@Generated("mdsal-binding-generator") public class PopVlanActionCaseBuilder extends Object
Class that buildsPopVlanActionCase
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:
PopVlanActionCase createPopVlanActionCase(int fooXyzzy, int barBaz) { return new PopVlanActionCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PopVlanActionCase, 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:
PopVlanActionCase
- 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 PopVlanActionCaseBuilder()
Construct an empty builder.PopVlanActionCaseBuilder(PopVlanActionCase base)
Construct a builder initialized with state from specifiedPopVlanActionCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PopVlanActionCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanActionCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanActionCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PopVlanActionCase
build()
A newPopVlanActionCase
instance.PopVlanAction
getPopVlanAction()
Return current value associated with the property corresponding toPopVlanActionCase.getPopVlanAction()
.PopVlanActionCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanActionCase>> augmentationType)
Remove an augmentation from this builder's product.PopVlanActionCaseBuilder
setPopVlanAction(PopVlanAction value)
Set the property corresponding toPopVlanActionCase.getPopVlanAction()
to the specified value.
-
-
-
Constructor Detail
-
PopVlanActionCaseBuilder
public PopVlanActionCaseBuilder()
Construct an empty builder.
-
PopVlanActionCaseBuilder
public PopVlanActionCaseBuilder(PopVlanActionCase base)
Construct a builder initialized with state from specifiedPopVlanActionCase
.- Parameters:
base
- PopVlanActionCase from which the builder should be initialized
-
-
Method Detail
-
getPopVlanAction
public PopVlanAction getPopVlanAction()
Return current value associated with the property corresponding toPopVlanActionCase.getPopVlanAction()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanActionCase>> 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
-
setPopVlanAction
public PopVlanActionCaseBuilder setPopVlanAction(PopVlanAction value)
Set the property corresponding toPopVlanActionCase.getPopVlanAction()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PopVlanActionCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanActionCase> 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 PopVlanActionCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanActionCase>> 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 PopVlanActionCase build()
A newPopVlanActionCase
instance.- Returns:
- A new
PopVlanActionCase
instance.
-
-