org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.eth.type.grouping

Class NxmOfEthTypeBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.match.rev140714.nxm.of.eth.type.grouping.NxmOfEthTypeBuilder

All Implemented Interfaces:

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

public class NxmOfEthTypeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmOfEthType>

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

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

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

NxmOfEthTypeBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmOfEthTypeBuilder()
NxmOfEthTypeBuilder(NxmOfEthType base)

Method Summary

Modifier and Type	Method and Description
NxmOfEthTypeBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>> E$$	augmentation(Class<E$$> augmentationType)
NxmOfEthType	build()
Integer	getValue()
NxmOfEthTypeBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxmOfEthType>> augmentationType)
NxmOfEthTypeBuilder	setValue(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmOfEthTypeBuilder

public NxmOfEthTypeBuilder()

NxmOfEthTypeBuilder

public NxmOfEthTypeBuilder(NxmOfEthType base)

Method Detail

getValue

public Integer getValue()

augmentation

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

setValue

public NxmOfEthTypeBuilder setValue(Integer value)

addAugmentation

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

removeAugmentation

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

build

public NxmOfEthType build()

Specified by:

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