org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.copy.value.into.field._case

Class FlowModCopyValueIntoFieldBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.copy.value.into.field._case.FlowModCopyValueIntoFieldBuilder

All Implemented Interfaces:

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

public class FlowModCopyValueIntoFieldBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowModCopyValueIntoField>

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

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

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

FlowModCopyValueIntoFieldBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowModCopyValueIntoFieldBuilder()
FlowModCopyValueIntoFieldBuilder(FlowModCopyValueIntoField base)

Method Summary

Modifier and Type	Method and Description
FlowModCopyValueIntoFieldBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoField>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoField> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoField>> E$$	augmentation(Class<E$$> augmentationType)
FlowModCopyValueIntoField	build()
Long	getDstField()
Integer	getDstOfs()
Integer	getFlowModNumBits()
Integer	getValue()
FlowModCopyValueIntoFieldBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModCopyValueIntoField>> augmentationType)
FlowModCopyValueIntoFieldBuilder	setDstField(Long value)
FlowModCopyValueIntoFieldBuilder	setDstOfs(Integer value)
FlowModCopyValueIntoFieldBuilder	setFlowModNumBits(Integer value)
FlowModCopyValueIntoFieldBuilder	setValue(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModCopyValueIntoFieldBuilder

public FlowModCopyValueIntoFieldBuilder()

FlowModCopyValueIntoFieldBuilder

public FlowModCopyValueIntoFieldBuilder(FlowModCopyValueIntoField base)

Method Detail

getDstField

public Long getDstField()

getDstOfs

public Integer getDstOfs()

getFlowModNumBits

public Integer getFlowModNumBits()

getValue

public Integer getValue()

augmentation

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

setDstField

public FlowModCopyValueIntoFieldBuilder setDstField(Long value)

setDstOfs

public FlowModCopyValueIntoFieldBuilder setDstOfs(Integer value)

setFlowModNumBits

public FlowModCopyValueIntoFieldBuilder setFlowModNumBits(Integer value)

setValue

public FlowModCopyValueIntoFieldBuilder setValue(Integer value)

addAugmentation

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

removeAugmentation

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

build

public FlowModCopyValueIntoField build()

Specified by:

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