Class NxmNxCtStateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.ct.state.grouping.NxmNxCtStateBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<NxmNxCtState>
,org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxCtState,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class NxmNxCtStateBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<NxmNxCtState>
Class that buildsNxmNxCtState
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:
NxmNxCtState createNxmNxCtState(int fooXyzzy, int barBaz) { return new NxmNxCtStateBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of NxmNxCtState, 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:
NxmNxCtState
,Builder
-
-
Constructor Summary
Constructors Constructor Description NxmNxCtStateBuilder()
NxmNxCtStateBuilder(NxmNxCtState base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NxmNxCtStateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>>
E$$augmentation(Class<E$$> augmentationType)
NxmNxCtState
build()
org.opendaylight.yangtools.yang.common.Uint32
getCtState()
org.opendaylight.yangtools.yang.common.Uint32
getMask()
NxmNxCtStateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> augmentationType)
Remove an augmentation from this builder's product.NxmNxCtStateBuilder
setCtState(org.opendaylight.yangtools.yang.common.Uint32 value)
NxmNxCtStateBuilder
setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
NxmNxCtStateBuilder
public NxmNxCtStateBuilder()
-
NxmNxCtStateBuilder
public NxmNxCtStateBuilder(NxmNxCtState base)
-
-
Method Detail
-
getCtState
public org.opendaylight.yangtools.yang.common.Uint32 getCtState()
-
getMask
public org.opendaylight.yangtools.yang.common.Uint32 getMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> E$$ augmentation(Class<E$$> augmentationType)
-
setCtState
public NxmNxCtStateBuilder setCtState(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMask
public NxmNxCtStateBuilder setMask(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public NxmNxCtStateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState> 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 NxmNxCtStateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> 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 NxmNxCtState build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<NxmNxCtState>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxCtState,IllegalArgumentException>
-
-