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