org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819

Class FlowUpdatedBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowUpdatedBuilder

All Implemented Interfaces:

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

public class FlowUpdatedBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<FlowUpdated>

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

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

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

FlowUpdatedBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
FlowUpdatedBuilder()
FlowUpdatedBuilder(Flow arg)
FlowUpdatedBuilder(FlowUpdated base)
FlowUpdatedBuilder(GenericFlowAttributes arg)
FlowUpdatedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
FlowUpdatedBuilder(NodeFlow arg)
FlowUpdatedBuilder(TransactionAware arg)
FlowUpdatedBuilder(TransactionMetadata arg)

Method Summary

Modifier and Type	Method and Description
FlowUpdatedBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowUpdated>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowUpdated> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowUpdated>> E$$	augmentation(Class<E$$> augmentationType)
FlowUpdated	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Long	getBufferId()
String	getContainerName()
FlowCookie	getCookie()
FlowCookie	getCookieMask()
FlowModFlags	getFlags()
String	getFlowName()
FlowRef	getFlowRef()
FlowTableRef	getFlowTable()
Integer	getHardTimeout()
Integer	getIdleTimeout()
Instructions	getInstructions()
Match	getMatch()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef	getNode()
Long	getOutGroup()
BigInteger	getOutPort()
Integer	getPriority()
Short	getTableId()
TransactionId	getTransactionId()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri	getTransactionUri()
Boolean	isBarrier()
Boolean	isInstallHw()
Boolean	isStrict()
FlowUpdatedBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowUpdated>> augmentationType)
FlowUpdatedBuilder	setBarrier(Boolean value)
FlowUpdatedBuilder	setBufferId(Long value)
FlowUpdatedBuilder	setContainerName(String value)
FlowUpdatedBuilder	setCookie(FlowCookie value)
FlowUpdatedBuilder	setCookieMask(FlowCookie value)
FlowUpdatedBuilder	setFlags(FlowModFlags value)
FlowUpdatedBuilder	setFlowName(String value)
FlowUpdatedBuilder	setFlowRef(FlowRef value)
FlowUpdatedBuilder	setFlowTable(FlowTableRef value)
FlowUpdatedBuilder	setHardTimeout(Integer value)
FlowUpdatedBuilder	setIdleTimeout(Integer value)
FlowUpdatedBuilder	setInstallHw(Boolean value)
FlowUpdatedBuilder	setInstructions(Instructions value)
FlowUpdatedBuilder	setMatch(Match value)
FlowUpdatedBuilder	setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
FlowUpdatedBuilder	setOutGroup(Long value)
FlowUpdatedBuilder	setOutPort(BigInteger value)
FlowUpdatedBuilder	setPriority(Integer value)
FlowUpdatedBuilder	setStrict(Boolean value)
FlowUpdatedBuilder	setTableId(Short value)
FlowUpdatedBuilder	setTransactionId(TransactionId value)
FlowUpdatedBuilder	setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowUpdatedBuilder

public FlowUpdatedBuilder()

FlowUpdatedBuilder

public FlowUpdatedBuilder(TransactionMetadata arg)

FlowUpdatedBuilder

public FlowUpdatedBuilder(TransactionAware arg)

FlowUpdatedBuilder

public FlowUpdatedBuilder(NodeFlow arg)

FlowUpdatedBuilder

public FlowUpdatedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)

FlowUpdatedBuilder

public FlowUpdatedBuilder(Flow arg)

FlowUpdatedBuilder

public FlowUpdatedBuilder(GenericFlowAttributes arg)

FlowUpdatedBuilder

public FlowUpdatedBuilder(FlowUpdated 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.flow.transaction.rev150304.TransactionMetadata
• org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware
• org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.Flow
• org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
• org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef
• org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.NodeFlow

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getBufferId

public Long getBufferId()

getContainerName

public String getContainerName()

getCookie

public FlowCookie getCookie()

getCookieMask

public FlowCookie getCookieMask()

getFlags

public FlowModFlags getFlags()

getFlowName

public String getFlowName()

getFlowRef

public FlowRef getFlowRef()

getFlowTable

public FlowTableRef getFlowTable()

getHardTimeout

public Integer getHardTimeout()

getIdleTimeout

public Integer getIdleTimeout()

getInstructions

public Instructions getInstructions()

getMatch

public Match getMatch()

getNode

public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()

getOutGroup

public Long getOutGroup()

getOutPort

public BigInteger getOutPort()

getPriority

public Integer getPriority()

getTableId

public Short getTableId()

getTransactionId

public TransactionId getTransactionId()

getTransactionUri

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()

isBarrier

public Boolean isBarrier()

isInstallHw

public Boolean isInstallHw()

isStrict

public Boolean isStrict()

augmentation

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

setBufferId

public FlowUpdatedBuilder setBufferId(Long value)

setContainerName

public FlowUpdatedBuilder setContainerName(String value)

setCookie

public FlowUpdatedBuilder setCookie(FlowCookie value)

setCookieMask

public FlowUpdatedBuilder setCookieMask(FlowCookie value)

setFlags

public FlowUpdatedBuilder setFlags(FlowModFlags value)

setFlowName

public FlowUpdatedBuilder setFlowName(String value)

setFlowRef

public FlowUpdatedBuilder setFlowRef(FlowRef value)

setFlowTable

public FlowUpdatedBuilder setFlowTable(FlowTableRef value)

setHardTimeout

public FlowUpdatedBuilder setHardTimeout(Integer value)

setIdleTimeout

public FlowUpdatedBuilder setIdleTimeout(Integer value)

setInstructions

public FlowUpdatedBuilder setInstructions(Instructions value)

setMatch

public FlowUpdatedBuilder setMatch(Match value)

setNode

public FlowUpdatedBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)

setOutGroup

public FlowUpdatedBuilder setOutGroup(Long value)

setOutPort

public FlowUpdatedBuilder setOutPort(BigInteger value)

setPriority

public FlowUpdatedBuilder setPriority(Integer value)

setTableId

public FlowUpdatedBuilder setTableId(Short value)

setTransactionId

public FlowUpdatedBuilder setTransactionId(TransactionId value)

setTransactionUri

public FlowUpdatedBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)

setBarrier

public FlowUpdatedBuilder setBarrier(Boolean value)

setInstallHw

public FlowUpdatedBuilder setInstallHw(Boolean value)

setStrict

public FlowUpdatedBuilder setStrict(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public FlowUpdated build()

Specified by:

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