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