org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.ct.state.grouping

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>

public class NxmNxCtStateBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxCtState>

Class that builds NxmNxCtStateBuilder 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:

   
     NxmNxCtStateBuilder createTarget(int fooXyzzy, int barBaz) {
         return new NxmNxCtStateBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of NxmNxCtStateBuilder, 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:

NxmNxCtStateBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxCtStateBuilder()
NxmNxCtStateBuilder(NxmNxCtState base)

Method Summary

Modifier and Type	Method and Description
NxmNxCtStateBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxCtState	build()
Long	getCtState()
Long	getMask()
NxmNxCtStateBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> augmentationType)
NxmNxCtStateBuilder	setCtState(Long value)
NxmNxCtStateBuilder	setMask(Long value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NxmNxCtStateBuilder

public NxmNxCtStateBuilder()

NxmNxCtStateBuilder

public NxmNxCtStateBuilder(NxmNxCtState base)

Method Detail

getCtState

public Long getCtState()

getMask

public Long getMask()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> E$$ augmentation(Class<E$$> augmentationType)

setCtState

public NxmNxCtStateBuilder setCtState(Long value)

setMask

public NxmNxCtStateBuilder setMask(Long value)

addAugmentation

public NxmNxCtStateBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> augmentationType,
                                           org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState> augmentationValue)

removeAugmentation

public NxmNxCtStateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxCtState>> augmentationType)

build

public NxmNxCtState build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxCtState,IllegalArgumentException>