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

Class NxmOfIcmpTypeBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxmOfIcmpTypeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxmOfIcmpType>

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

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

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

NxmOfIcmpTypeBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxmOfIcmpTypeBuilder()
NxmOfIcmpTypeBuilder(NxmOfIcmpType base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

NxmOfIcmpTypeBuilder

public NxmOfIcmpTypeBuilder()

NxmOfIcmpTypeBuilder

public NxmOfIcmpTypeBuilder(NxmOfIcmpType base)

Method Detail

getValue

public Short getValue()

augmentation

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

setValue

public NxmOfIcmpTypeBuilder setValue(Short value)

addAugmentation

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

removeAugmentation

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

build

public NxmOfIcmpType build()

Specified by:

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