Class NxActionEncapBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.encap.grouping.NxActionEncapBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxActionEncap>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxActionEncap,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxActionEncapBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxActionEncap>
Class that buildsNxActionEncapBuilder
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:
NxActionEncapBuilder createTarget(int fooXyzzy, int barBaz) { return new NxActionEncapBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxActionEncapBuilder, 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:
NxActionEncapBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxActionEncapBuilder()
NxActionEncapBuilder(NxActionEncap base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description NxActionEncapBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>>
E$$augmentation(Class<E$$> augmentationType)
NxActionEncap
build()
ExperimenterId
getExperimenterId()
org.opendaylight.yangtools.yang.common.Uint32
getPacketType()
NxActionEncapBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>> augmentationType)
Remove an augmentation from this builder's product.NxActionEncapBuilder
setExperimenterId(ExperimenterId value)
NxActionEncapBuilder
setPacketType(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPacketType(Uint32)
instead.NxActionEncapBuilder
setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
NxActionEncapBuilder
public NxActionEncapBuilder()
-
NxActionEncapBuilder
public NxActionEncapBuilder(NxActionEncap base)
-
-
Method Detail
-
getExperimenterId
public ExperimenterId getExperimenterId()
-
getPacketType
public org.opendaylight.yangtools.yang.common.Uint32 getPacketType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>> E$$ augmentation(Class<E$$> augmentationType)
-
setExperimenterId
public NxActionEncapBuilder setExperimenterId(ExperimenterId value)
-
setPacketType
public NxActionEncapBuilder setPacketType(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPacketType
@Deprecated(forRemoval=true) public NxActionEncapBuilder setPacketType(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPacketType(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public NxActionEncapBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap> 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 NxActionEncapBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionEncap>> 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 NxActionEncap build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxActionEncap>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxActionEncap,IllegalArgumentException>
-
-