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