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

Class NxmNxTunIdBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.tun.id.grouping.NxmNxTunIdBuilder

All Implemented Interfaces:

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

public class NxmNxTunIdBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxTunId>

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

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

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

NxmNxTunIdBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxTunIdBuilder()
NxmNxTunIdBuilder(NxmNxTunId base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxTunIdBuilder

public NxmNxTunIdBuilder()

NxmNxTunIdBuilder

public NxmNxTunIdBuilder(NxmNxTunId base)

Method Detail

getValue

public BigInteger getValue()

augmentation

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

setValue

public NxmNxTunIdBuilder setValue(BigInteger value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxTunId build()

Specified by:

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