org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.output.to.port._case

Class FlowModOutputToPortBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.flow.mod.spec.flow.mod.spec.flow.mod.output.to.port._case.FlowModOutputToPortBuilder

All Implemented Interfaces:

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

public class FlowModOutputToPortBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowModOutputToPort>

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

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

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

FlowModOutputToPortBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowModOutputToPortBuilder()
FlowModOutputToPortBuilder(FlowModOutputToPort base)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModOutputToPortBuilder

public FlowModOutputToPortBuilder()

FlowModOutputToPortBuilder

public FlowModOutputToPortBuilder(FlowModOutputToPort base)

Method Detail

getFlowModNumBits

public Integer getFlowModNumBits()

getSrcField

public Long getSrcField()

getSrcOfs

public Integer getSrcOfs()

augmentation

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

setFlowModNumBits

public FlowModOutputToPortBuilder setFlowModNumBits(Integer value)

setSrcField

public FlowModOutputToPortBuilder setSrcField(Long value)

setSrcOfs

public FlowModOutputToPortBuilder setSrcOfs(Integer value)

addAugmentation

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

removeAugmentation

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

build

public FlowModOutputToPort build()

Specified by:

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