org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.flow.mod.add.match.from.field._case

Class FlowModAddMatchFromFieldBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.flow.mod.spec.flow.mod.spec.flow.mod.add.match.from.field._case.FlowModAddMatchFromFieldBuilder

All Implemented Interfaces:

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

public class FlowModAddMatchFromFieldBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowModAddMatchFromField>

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

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

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

FlowModAddMatchFromFieldBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowModAddMatchFromFieldBuilder()
FlowModAddMatchFromFieldBuilder(FlowModAddMatchFromField base)

Method Summary

Modifier and Type	Method and Description
FlowModAddMatchFromFieldBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> E$$	augmentation(Class<E$$> augmentationType)
FlowModAddMatchFromField	build()
Long	getDstField()
Integer	getDstOfs()
Integer	getFlowModNumBits()
Long	getSrcField()
Integer	getSrcOfs()
FlowModAddMatchFromFieldBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowModAddMatchFromField>> augmentationType)
FlowModAddMatchFromFieldBuilder	setDstField(Long value)
FlowModAddMatchFromFieldBuilder	setDstOfs(Integer value)
FlowModAddMatchFromFieldBuilder	setFlowModNumBits(Integer value)
FlowModAddMatchFromFieldBuilder	setSrcField(Long value)
FlowModAddMatchFromFieldBuilder	setSrcOfs(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModAddMatchFromFieldBuilder

public FlowModAddMatchFromFieldBuilder()

FlowModAddMatchFromFieldBuilder

public FlowModAddMatchFromFieldBuilder(FlowModAddMatchFromField base)

Method Detail

getDstField

public Long getDstField()

getDstOfs

public Integer getDstOfs()

getFlowModNumBits

public Integer getFlowModNumBits()

getSrcField

public Long getSrcField()

getSrcOfs

public Integer getSrcOfs()

augmentation

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

setDstField

public FlowModAddMatchFromFieldBuilder setDstField(Long value)

setDstOfs

public FlowModAddMatchFromFieldBuilder setDstOfs(Integer value)

setFlowModNumBits

public FlowModAddMatchFromFieldBuilder setFlowModNumBits(Integer value)

setSrcField

public FlowModAddMatchFromFieldBuilder setSrcField(Long value)

setSrcOfs

public FlowModAddMatchFromFieldBuilder setSrcOfs(Integer value)

addAugmentation

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

removeAugmentation

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

build

public FlowModAddMatchFromField build()

Specified by:

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