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

Class NxMultipathBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class NxMultipathBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<NxMultipath>

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

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

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

NxMultipathBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
NxMultipathBuilder()
NxMultipathBuilder(NxMultipath base)

Method Summary

Modifier and Type	Method and Description
NxMultipathBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> E$$	augmentation(Class<E$$> augmentationType)
NxMultipath	build()
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxMpAlgorithm	getAlgorithm()
Long	getArg()
Integer	getBasis()
Dst	getDst()
org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxHashFields	getFields()
Integer	getMaxLink()
NxMultipathBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NxMultipath>> augmentationType)
NxMultipathBuilder	setAlgorithm(org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxMpAlgorithm value)
NxMultipathBuilder	setArg(Long value)
NxMultipathBuilder	setBasis(Integer value)
NxMultipathBuilder	setDst(Dst value)
NxMultipathBuilder	setFields(org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxHashFields value)
NxMultipathBuilder	setMaxLink(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

NxMultipathBuilder

public NxMultipathBuilder()

NxMultipathBuilder

public NxMultipathBuilder(NxMultipath base)

Method Detail

getAlgorithm

public org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxMpAlgorithm getAlgorithm()

getArg

public Long getArg()

getBasis

public Integer getBasis()

getDst

public Dst getDst()

getFields

public org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxHashFields getFields()

getMaxLink

public Integer getMaxLink()

augmentation

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

setAlgorithm

public NxMultipathBuilder setAlgorithm(org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxMpAlgorithm value)

setArg

public NxMultipathBuilder setArg(Long value)

setBasis

public NxMultipathBuilder setBasis(Integer value)

setDst

public NxMultipathBuilder setDst(Dst value)

setFields

public NxMultipathBuilder setFields(org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.OfjNxHashFields value)

setMaxLink

public NxMultipathBuilder setMaxLink(Integer value)

addAugmentation

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

removeAugmentation

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

build

public NxMultipath build()

Specified by:

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