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