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