org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec

Class FlowModCopyValueIntoFieldCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.FlowModCopyValueIntoFieldCaseBuilder

All Implemented Interfaces:

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

public class FlowModCopyValueIntoFieldCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowModCopyValueIntoFieldCase>

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

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

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

FlowModCopyValueIntoFieldCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowModCopyValueIntoFieldCaseBuilder()
FlowModCopyValueIntoFieldCaseBuilder(FlowModCopyValueIntoFieldCase base)

Method Summary

Modifier and Type	Method and Description
FlowModCopyValueIntoFieldCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>> E$$	augmentation(Class<E$$> augmentationType)
FlowModCopyValueIntoFieldCase	build()
FlowModCopyValueIntoField	getFlowModCopyValueIntoField()
FlowModCopyValueIntoFieldCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoFieldCase>> augmentationType)
FlowModCopyValueIntoFieldCaseBuilder	setFlowModCopyValueIntoField(FlowModCopyValueIntoField value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModCopyValueIntoFieldCaseBuilder

public FlowModCopyValueIntoFieldCaseBuilder()

FlowModCopyValueIntoFieldCaseBuilder

public FlowModCopyValueIntoFieldCaseBuilder(FlowModCopyValueIntoFieldCase base)

Method Detail

getFlowModCopyValueIntoField

public FlowModCopyValueIntoField getFlowModCopyValueIntoField()

augmentation

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

setFlowModCopyValueIntoField

public FlowModCopyValueIntoFieldCaseBuilder setFlowModCopyValueIntoField(FlowModCopyValueIntoField value)

addAugmentation

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

removeAugmentation

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

build

public FlowModCopyValueIntoFieldCase build()

Specified by:

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