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