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

Class NxmNxNshNpBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsh.np.grouping.NxmNxNshNpBuilder

All Implemented Interfaces:

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

public class NxmNxNshNpBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxNshNp>

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

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

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

NxmNxNshNpBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxNshNpBuilder()
NxmNxNshNpBuilder(NxmNxNshNp base)

Method Summary

Modifier and Type	Method and Description
NxmNxNshNpBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshNp>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshNp> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshNp>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxNshNp	build()
Short	getValue()
NxmNxNshNpBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshNp>> augmentationType)
NxmNxNshNpBuilder	setValue(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxNshNpBuilder

public NxmNxNshNpBuilder()

NxmNxNshNpBuilder

public NxmNxNshNpBuilder(NxmNxNshNp base)

Method Detail

getValue

public Short getValue()

augmentation

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

setValue

public NxmNxNshNpBuilder setValue(Short value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxNshNp build()

Specified by:

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