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