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

Class NxmNxNshc1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nshc._1.grouping.NxmNxNshc1Builder

All Implemented Interfaces:

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

public class NxmNxNshc1Builder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxNshc1>

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

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

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

NxmNxNshc1Builder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxNshc1Builder()
NxmNxNshc1Builder(NxmNxNshc1 base)

Method Summary

Modifier and Type	Method and Description
NxmNxNshc1Builder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc1>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc1> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc1>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxNshc1	build()
Long	getMask()
Long	getValue()
NxmNxNshc1Builder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshc1>> augmentationType)
NxmNxNshc1Builder	setMask(Long value)
NxmNxNshc1Builder	setValue(Long value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxNshc1Builder

public NxmNxNshc1Builder()

NxmNxNshc1Builder

public NxmNxNshc1Builder(NxmNxNshc1 base)

Method Detail

getMask

public Long getMask()

getValue

public Long getValue()

augmentation

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

setMask

public NxmNxNshc1Builder setMask(Long value)

setValue

public NxmNxNshc1Builder setValue(Long value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxNshc1 build()

Specified by:

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