org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping

Class NxRegLoadBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.reg.load.grouping.NxRegLoadBuilder

All Implemented Interfaces:

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

public class NxRegLoadBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxRegLoad>

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

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

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

NxRegLoadBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxRegLoadBuilder()
NxRegLoadBuilder(NxRegLoad base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NxRegLoadBuilder

public NxRegLoadBuilder()

NxRegLoadBuilder

public NxRegLoadBuilder(NxRegLoad base)

Method Detail

getDst

public Dst getDst()

getValue

public BigInteger getValue()

augmentation

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

setDst

public NxRegLoadBuilder setDst(Dst value)

setValue

public NxRegLoadBuilder setValue(BigInteger value)

addAugmentation

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

removeAugmentation

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

build

public NxRegLoad build()

Specified by:

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