org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.learn.grouping.nx.learn

Class FlowModsBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.learn.grouping.nx.learn.FlowModsBuilder

All Implemented Interfaces:

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

public class FlowModsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowMods>

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

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

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

FlowModsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowModsBuilder()
FlowModsBuilder(FlowMods base)
FlowModsBuilder(FlowModSpec arg)

Method Summary

Modifier and Type	Method and Description
FlowModsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowMods>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowMods> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowMods>> E$$	augmentation(Class<E$$> augmentationType)
FlowMods	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
FlowModSpec	getFlowModSpec()
FlowModsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowMods>> augmentationType)
FlowModsBuilder	setFlowModSpec(FlowModSpec value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowModsBuilder

public FlowModsBuilder()

FlowModsBuilder

public FlowModsBuilder(FlowModSpec arg)

FlowModsBuilder

public FlowModsBuilder(FlowMods base)

Method Detail

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)

Set fields from given grouping argument. Valid argument is instance of one of following types:

• org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.FlowModSpec

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getFlowModSpec

public FlowModSpec getFlowModSpec()

augmentation

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

setFlowModSpec

public FlowModsBuilder setFlowModSpec(FlowModSpec value)

addAugmentation

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

removeAugmentation

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

build

public FlowMods build()

Specified by:

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