Class ActionEncapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.action.container.action.choice.ActionEncapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ActionEncap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ActionEncap,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ActionEncapBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ActionEncap>
Class that buildsActionEncapBuilder
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:
ActionEncapBuilder createTarget(int fooXyzzy, int barBaz) { return new ActionEncapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ActionEncapBuilder, 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:
ActionEncapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ActionEncapBuilder()
ActionEncapBuilder(ActionEncap base)
ActionEncapBuilder(OfjNxActionEncapGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ActionEncapBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap>>
E$$augmentation(Class<E$$> augmentationType)
ActionEncap
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.NxActionEncap
getNxActionEncap()
ActionEncapBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap>> augmentationType)
ActionEncapBuilder
setNxActionEncap(NxActionEncap value)
-
-
-
Constructor Detail
-
ActionEncapBuilder
public ActionEncapBuilder()
-
ActionEncapBuilder
public ActionEncapBuilder(OfjNxActionEncapGrouping arg)
-
ActionEncapBuilder
public ActionEncapBuilder(ActionEncap 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.openflowjava.nx.action.rev140421.OfjNxActionEncapGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getNxActionEncap
public NxActionEncap getNxActionEncap()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap>> E$$ augmentation(Class<E$$> augmentationType)
-
setNxActionEncap
public ActionEncapBuilder setNxActionEncap(NxActionEncap value)
-
addAugmentation
public ActionEncapBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap> augmentationValue)
-
removeAugmentation
public ActionEncapBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ActionEncap>> augmentationType)
-
build
public ActionEncap build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ActionEncap>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ActionEncap,IllegalArgumentException>
-
-