Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.actions
Class ActionTypeBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.actions.ActionTypeBuilder
Class that builds
ActionType
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:
ActionType createActionType(int fooXyzzy, int barBaz) {
return new ActionTypeBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ActionType, 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:
-
Constructor Summary
ConstructorsConstructorDescriptionConstruct an empty builder.ActionTypeBuilder
(Feature arg) Construct a new builder initialized from specifiedFeature
.ActionTypeBuilder
(ActionType base) Construct a builder initialized with state from specifiedActionType
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<ActionType> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionType>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ActionType
build()
A newActionType
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toActionType.getAction()
.Return current value associated with the property corresponding toFeature.getSupportState()
.key()
Return current value associated with the property corresponding toActionType.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionType>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toActionType.getAction()
to the specified value.setSupportState
(SupportType value) Set the property corresponding toFeature.getSupportState()
to the specified value.withKey
(ActionTypeKey key) Set the key value corresponding toActionType.key()
to the specified value.
-
Constructor Details
-
ActionTypeBuilder
public ActionTypeBuilder()Construct an empty builder. -
ActionTypeBuilder
Construct a new builder initialized from specifiedFeature
.- Parameters:
arg
- Feature from which the builder should be initialized
-
ActionTypeBuilder
Construct a builder initialized with state from specifiedActionType
.- Parameters:
base
- ActionType from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
Return current value associated with the property corresponding toActionType.key()
.- Returns:
- current value
-
getAction
Return current value associated with the property corresponding toActionType.getAction()
.- Returns:
- current value
-
getSupportState
Return current value associated with the property corresponding toFeature.getSupportState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionType>> 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
-
withKey
Set the key value corresponding toActionType.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setAction
Set the property corresponding toActionType.getAction()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportState
Set the property corresponding toFeature.getSupportState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ActionTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ActionType> 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 ActionTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionType>> 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
A newActionType
instance.- Returns:
- A new
ActionType
instance.
-