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

Class NxmNxNsiBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsi.grouping.NxmNxNsiBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<NxmNxNsi>, org.opendaylight.yangtools.concepts.CheckedBuilder<NxmNxNsi,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class NxmNxNsiBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxNsi>

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

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

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

NxmNxNsiBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxNsiBuilder()
NxmNxNsiBuilder(NxmNxNsi base)

Method Summary

Modifier and Type	Method and Description
NxmNxNsiBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNsi>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNsi> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNsi>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxNsi	build()
Short	getNsi()
NxmNxNsiBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNsi>> augmentationType)
NxmNxNsiBuilder	setNsi(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxNsiBuilder

public NxmNxNsiBuilder()

NxmNxNsiBuilder

public NxmNxNsiBuilder(NxmNxNsi base)

Method Detail

getNsi

public Short getNsi()

augmentation

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

setNsi

public NxmNxNsiBuilder setNsi(Short value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxNsi build()

Specified by:

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