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