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

Class NxmNxNshTtlBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxmNxNshTtlBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmNxNshTtl>

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

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

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

NxmNxNshTtlBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmNxNshTtlBuilder()
NxmNxNshTtlBuilder(NxmNxNshTtl base)

Method Summary

Modifier and Type	Method and Description
NxmNxNshTtlBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshTtl>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshTtl> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshTtl>> E$$	augmentation(Class<E$$> augmentationType)
NxmNxNshTtl	build()
Short	getNshTtl()
NxmNxNshTtlBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmNxNshTtl>> augmentationType)
NxmNxNshTtlBuilder	setNshTtl(Short value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmNxNshTtlBuilder

public NxmNxNshTtlBuilder()

NxmNxNshTtlBuilder

public NxmNxNshTtlBuilder(NxmNxNshTtl base)

Method Detail

getNshTtl

public Short getNshTtl()

augmentation

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

setNshTtl

public NxmNxNshTtlBuilder setNshTtl(Short value)

addAugmentation

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

removeAugmentation

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

build

public NxmNxNshTtl build()

Specified by:

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