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

Class FlowModCopyFieldIntoFieldCaseBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class FlowModCopyFieldIntoFieldCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowModCopyFieldIntoFieldCase>

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

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

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

FlowModCopyFieldIntoFieldCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowModCopyFieldIntoFieldCaseBuilder()
FlowModCopyFieldIntoFieldCaseBuilder(FlowModCopyFieldIntoFieldCase base)

Method Summary

Modifier and Type	Method and Description
FlowModCopyFieldIntoFieldCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoFieldCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoFieldCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoFieldCase>> E$$	augmentation(Class<E$$> augmentationType)
FlowModCopyFieldIntoFieldCase	build()
FlowModCopyFieldIntoField	getFlowModCopyFieldIntoField()
FlowModCopyFieldIntoFieldCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyFieldIntoFieldCase>> augmentationType)
FlowModCopyFieldIntoFieldCaseBuilder	setFlowModCopyFieldIntoField(FlowModCopyFieldIntoField value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModCopyFieldIntoFieldCaseBuilder

public FlowModCopyFieldIntoFieldCaseBuilder()

FlowModCopyFieldIntoFieldCaseBuilder

public FlowModCopyFieldIntoFieldCaseBuilder(FlowModCopyFieldIntoFieldCase base)

Method Detail

getFlowModCopyFieldIntoField

public FlowModCopyFieldIntoField getFlowModCopyFieldIntoField()

augmentation

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

setFlowModCopyFieldIntoField

public FlowModCopyFieldIntoFieldCaseBuilder setFlowModCopyFieldIntoField(FlowModCopyFieldIntoField value)

addAugmentation

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

removeAugmentation

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

build

public FlowModCopyFieldIntoFieldCase build()

Specified by:

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