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

Class NxmNxRegBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxmNxRegBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxReg>

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

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

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

NxmNxRegBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxRegBuilder()
NxmNxRegBuilder(NxmNxReg base)

Method Summary

Modifier and Type	Method and Description
NxmNxRegBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxReg	build()
Long	getMask()
Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg>	getReg()
Long	getValue()
NxmNxRegBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxReg>> augmentationType)
NxmNxRegBuilder	setMask(Long value)
NxmNxRegBuilder	setReg(Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg> value)
NxmNxRegBuilder	setValue(Long value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxRegBuilder

public NxmNxRegBuilder()

NxmNxRegBuilder

public NxmNxRegBuilder(NxmNxReg base)

Method Detail

getMask

public Long getMask()

getReg

public Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg> getReg()

getValue

public Long getValue()

augmentation

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

setMask

public NxmNxRegBuilder setMask(Long value)

setReg

public NxmNxRegBuilder setReg(Class<? extends org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.NxmNxReg> value)

setValue

public NxmNxRegBuilder setValue(Long value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxReg build()

Specified by:

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