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

Class NxOutputRegBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxOutputRegBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxOutputReg>

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

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

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

NxOutputRegBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxOutputRegBuilder()
NxOutputRegBuilder(NxOutputReg base)

Method Summary

Modifier and Type	Method and Description
NxOutputRegBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> E$$	augmentation(Class<E$$> augmentationType)
NxOutputReg	build()
Integer	getMaxLen()
Src	getSrc()
NxOutputRegBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxOutputReg>> augmentationType)
NxOutputRegBuilder	setMaxLen(Integer value)
NxOutputRegBuilder	setSrc(Src value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxOutputRegBuilder

public NxOutputRegBuilder()

NxOutputRegBuilder

public NxOutputRegBuilder(NxOutputReg base)

Method Detail

getMaxLen

public Integer getMaxLen()

getSrc

public Src getSrc()

augmentation

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

setMaxLen

public NxOutputRegBuilder setMaxLen(Integer value)

setSrc

public NxOutputRegBuilder setSrc(Src value)

addAugmentation

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

removeAugmentation

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

build

public NxOutputReg build()

Specified by:

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