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

Class NxmNxNshFlagsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.nx.nsh.flags.grouping.NxmNxNshFlagsBuilder

All Implemented Interfaces:

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

public class NxmNxNshFlagsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxNshFlags>

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

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

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

NxmNxNshFlagsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxNshFlagsBuilder()
NxmNxNshFlagsBuilder(NxmNxNshFlags base)

Method Summary

Modifier and Type	Method and Description
NxmNxNshFlagsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshFlags>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshFlags> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshFlags>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxNshFlags	build()
Short	getMask()
Short	getNshFlags()
NxmNxNshFlagsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshFlags>> augmentationType)
NxmNxNshFlagsBuilder	setMask(Short value)
NxmNxNshFlagsBuilder	setNshFlags(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxNshFlagsBuilder

public NxmNxNshFlagsBuilder()

NxmNxNshFlagsBuilder

public NxmNxNshFlagsBuilder(NxmNxNshFlags base)

Method Detail

getMask

public Short getMask()

getNshFlags

public Short getNshFlags()

augmentation

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

setMask

public NxmNxNshFlagsBuilder setMask(Short value)

setNshFlags

public NxmNxNshFlagsBuilder setNshFlags(Short value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxNshFlags build()

Specified by:

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