Class PopVlanCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.PopVlanCaseBuilder
-
@Generated("mdsal-binding-generator") public class PopVlanCaseBuilder extends Object
Class that buildsPopVlanCase
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:
PopVlanCase createPopVlanCase(int fooXyzzy, int barBaz) { return new PopVlanCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PopVlanCase, 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:
PopVlanCase
- 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 PopVlanCaseBuilder()
Construct an empty builder.PopVlanCaseBuilder(PopVlanCase base)
Construct a builder initialized with state from specifiedPopVlanCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PopVlanCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PopVlanCase
build()
A newPopVlanCase
instance.PopVlanCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanCase>> augmentationType)
Remove an augmentation from this builder's product.
-
-
-
Constructor Detail
-
PopVlanCaseBuilder
public PopVlanCaseBuilder()
Construct an empty builder.
-
PopVlanCaseBuilder
public PopVlanCaseBuilder(PopVlanCase base)
Construct a builder initialized with state from specifiedPopVlanCase
.- Parameters:
base
- PopVlanCase from which the builder should be initialized
-
-
Method Detail
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanCase>> 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
-
addAugmentation
public PopVlanCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanCase> 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 PopVlanCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PopVlanCase>> 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 PopVlanCase build()
A newPopVlanCase
instance.- Returns:
- A new
PopVlanCase
instance.
-
-