Class ActionsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.routing.policy.top.routing.policy.policy.definitions.policy.definition.statements.statement.ActionsBuilder
Class that builds
Actions
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:
Actions createActions(int fooXyzzy, int barBaz) {
return new ActionsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Actions, 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
ConstructorDescriptionConstruct an empty builder.Construct a new builder initialized from specifiedGenericActions
.ActionsBuilder
(IgpActions arg) Construct a new builder initialized from specifiedIgpActions
.ActionsBuilder
(Actions base) Construct a builder initialized with state from specifiedActions
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Actions> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Actions>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Actions
build()
A newActions
instance.static @NonNull Actions
empty()
Get empty instance of Actions.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toIgpActions.getIgpActions()
.Return current value associated with the property corresponding toGenericActions.getRouteDisposition()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Actions>> augmentationType) Remove an augmentation from this builder's product.setIgpActions
(IgpActions value) Set the property corresponding toIgpActions.getIgpActions()
to the specified value.Set the property corresponding toGenericActions.getRouteDisposition()
to the specified value.
-
Constructor Details
-
ActionsBuilder
public ActionsBuilder()Construct an empty builder. -
ActionsBuilder
Construct a new builder initialized from specifiedGenericActions
.- Parameters:
arg
- GenericActions from which the builder should be initialized
-
ActionsBuilder
Construct a new builder initialized from specifiedIgpActions
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.IgpActions from which the builder should be initialized
-
ActionsBuilder
Construct a builder initialized with state from specifiedActions
.- Parameters:
base
- Actions 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
-
empty
Get empty instance of Actions.- Returns:
- An empty
Actions
-
getIgpActions
Return current value associated with the property corresponding toIgpActions.getIgpActions()
.- Returns:
- current value
-
getRouteDisposition
Return current value associated with the property corresponding toGenericActions.getRouteDisposition()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Actions>> 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
-
setIgpActions
Set the property corresponding toIgpActions.getIgpActions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setRouteDisposition
Set the property corresponding toGenericActions.getRouteDisposition()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ActionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Actions> 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 ActionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Actions>> 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 newActions
instance.- Returns:
- A new
Actions
instance.
-