Class ActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.ActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Action>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Action,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Action>
Class that buildsAction
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:
Action createAction(int fooXyzzy, int barBaz) { return new ActionBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Action, 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:
Action
,Builder
-
-
Constructor Summary
Constructors Constructor Description ActionBuilder()
ActionBuilder(Action arg)
ActionBuilder(Action base)
ActionBuilder(Ordered arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Action> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Action>>
E$$augmentation(Class<E$$> augmentationType)
Action
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Action
getAction()
Integer
getOrder()
ActionKey
key()
ActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Action>> augmentationType)
Remove an augmentation from this builder's product.ActionBuilder
setAction(Action value)
ActionBuilder
setOrder(Integer value)
ActionBuilder
withKey(ActionKey key)
-
-
-
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.urn.opendaylight.action.types.rev131112.Action
- Ordered
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public ActionKey key()
-
getAction
public Action getAction()
-
getOrder
public Integer getOrder()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Action>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public ActionBuilder withKey(ActionKey key)
-
setAction
public ActionBuilder setAction(Action value)
-
setOrder
public ActionBuilder setOrder(Integer value)
-
addAugmentation
public ActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Action> 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 ActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Action>> 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 Action build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Action>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Action,IllegalArgumentException>
-
-