org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.ofpact.actions.ofpact.actions

Class NxActionNatCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.ofpact.actions.ofpact.actions.NxActionNatCaseBuilder

All Implemented Interfaces:

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

public class NxActionNatCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxActionNatCase>

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

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

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

NxActionNatCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxActionNatCaseBuilder()
NxActionNatCaseBuilder(NxActionNatCase base)

Method Summary

Modifier and Type	Method and Description
NxActionNatCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNatCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNatCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNatCase>> E$$	augmentation(Class<E$$> augmentationType)
NxActionNatCase	build()
NxActionNat	getNxActionNat()
NxActionNatCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionNatCase>> augmentationType)
NxActionNatCaseBuilder	setNxActionNat(NxActionNat value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxActionNatCaseBuilder

public NxActionNatCaseBuilder()

NxActionNatCaseBuilder

public NxActionNatCaseBuilder(NxActionNatCase base)

Method Detail

getNxActionNat

public NxActionNat getNxActionNat()

augmentation

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

setNxActionNat

public NxActionNatCaseBuilder setNxActionNat(NxActionNat value)

addAugmentation

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

removeAugmentation

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

build

public NxActionNatCase build()

Specified by:

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