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