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

Class NxActionCtMarkCaseBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxActionCtMarkCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxActionCtMarkCase>

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

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

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

NxActionCtMarkCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxActionCtMarkCaseBuilder()
NxActionCtMarkCaseBuilder(NxActionCtMarkCase base)

Method Summary

Modifier and Type	Method and Description
NxActionCtMarkCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtMarkCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtMarkCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtMarkCase>> E$$	augmentation(Class<E$$> augmentationType)
NxActionCtMarkCase	build()
NxActionCtMark	getNxActionCtMark()
NxActionCtMarkCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxActionCtMarkCase>> augmentationType)
NxActionCtMarkCaseBuilder	setNxActionCtMark(NxActionCtMark value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxActionCtMarkCaseBuilder

public NxActionCtMarkCaseBuilder()

NxActionCtMarkCaseBuilder

public NxActionCtMarkCaseBuilder(NxActionCtMarkCase base)

Method Detail

getNxActionCtMark

public NxActionCtMark getNxActionCtMark()

augmentation

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

setNxActionCtMark

public NxActionCtMarkCaseBuilder setNxActionCtMark(NxActionCtMark value)

addAugmentation

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

removeAugmentation

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

build

public NxActionCtMarkCase build()

Specified by:

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