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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Actions>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Actions,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ActionsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Actions>
Class that buildsActionsBuilder
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:
ActionsBuilder createTarget(int fooXyzzy, int barBaz) { return new ActionsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ActionsBuilder, 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 oportunities, 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:
ActionsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ActionsBuilder()
ActionsBuilder(GenericActions arg)
ActionsBuilder(IgpActions arg)
ActionsBuilder(Actions base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionsBuilder
addAugmentation(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)
Actions
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.IgpActions
getIgpActions()
RouteDisposition
getRouteDisposition()
ActionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Actions>> augmentationType)
Remove an augmentation from this builder's product.ActionsBuilder
setIgpActions(IgpActions value)
ActionsBuilder
setRouteDisposition(RouteDisposition value)
-
-
-
Constructor Detail
-
ActionsBuilder
public ActionsBuilder()
-
ActionsBuilder
public ActionsBuilder(GenericActions arg)
-
ActionsBuilder
public ActionsBuilder(IgpActions arg)
-
ActionsBuilder
public ActionsBuilder(Actions base)
-
-
Method Detail
-
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:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.GenericActions
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.IgpActions
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIgpActions
public IgpActions getIgpActions()
-
getRouteDisposition
public RouteDisposition getRouteDisposition()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Actions>> E$$ augmentation(Class<E$$> augmentationType)
-
setIgpActions
public ActionsBuilder setIgpActions(IgpActions value)
-
setRouteDisposition
public ActionsBuilder setRouteDisposition(RouteDisposition value)
-
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
public Actions build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Actions>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Actions,IllegalArgumentException>
-
-