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