Class FlowAddedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowAddedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowAdded>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowAdded,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlowAddedBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowAdded>
Class that buildsFlowAddedBuilder
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:
FlowAddedBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowAddedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowAddedBuilder, 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:
FlowAddedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowAddedBuilder()
FlowAddedBuilder(FlowAdded base)
FlowAddedBuilder(NodeFlow arg)
FlowAddedBuilder(TransactionAware arg)
FlowAddedBuilder(TransactionMetadata arg)
FlowAddedBuilder(Flow arg)
FlowAddedBuilder(GenericFlowAttributes arg)
FlowAddedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowAddedBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>>
E$$augmentation(Class<E$$> augmentationType)
FlowAdded
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
String
getFlowName()
FlowRef
getFlowRef()
FlowTableRef
getFlowTable()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Instructions
getInstructions()
Match
getMatch()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef
getNode()
org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
org.opendaylight.yangtools.yang.common.Uint64
getOutPort()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
org.opendaylight.yangtools.yang.common.Uint8
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()
FlowAddedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> augmentationType)
FlowAddedBuilder
setBarrier(Boolean value)
FlowAddedBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.FlowAddedBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowAddedBuilder
setContainerName(String value)
FlowAddedBuilder
setCookie(FlowCookie value)
FlowAddedBuilder
setCookieMask(FlowCookie value)
FlowAddedBuilder
setFlags(FlowModFlags value)
FlowAddedBuilder
setFlowName(String value)
FlowAddedBuilder
setFlowRef(FlowRef value)
FlowAddedBuilder
setFlowTable(FlowTableRef value)
FlowAddedBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.FlowAddedBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowAddedBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.FlowAddedBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowAddedBuilder
setInstallHw(Boolean value)
FlowAddedBuilder
setInstructions(Instructions value)
FlowAddedBuilder
setMatch(Match value)
FlowAddedBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
FlowAddedBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.FlowAddedBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowAddedBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutPort(Uint64)} instead.FlowAddedBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowAddedBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.FlowAddedBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowAddedBuilder
setStrict(Boolean value)
FlowAddedBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTableId(Uint8)} instead.FlowAddedBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowAddedBuilder
setTransactionId(TransactionId value)
FlowAddedBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
-
-
Constructor Detail
-
FlowAddedBuilder
public FlowAddedBuilder()
-
FlowAddedBuilder
public FlowAddedBuilder(TransactionMetadata arg)
-
FlowAddedBuilder
public FlowAddedBuilder(NodeFlow arg)
-
FlowAddedBuilder
public FlowAddedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
FlowAddedBuilder
public FlowAddedBuilder(Flow arg)
-
FlowAddedBuilder
public FlowAddedBuilder(GenericFlowAttributes arg)
-
FlowAddedBuilder
public FlowAddedBuilder(TransactionAware arg)
-
FlowAddedBuilder
public FlowAddedBuilder(FlowAdded 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.types.rev131026.Flow
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.transaction.rev150304.TransactionAware
- 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 org.opendaylight.yangtools.yang.common.Uint32 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 org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getInstructions
public Instructions getInstructions()
-
getMatch
public Match getMatch()
-
getNode
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNode()
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
-
getOutPort
public org.opendaylight.yangtools.yang.common.Uint64 getOutPort()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 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<FlowAdded>> E$$ augmentation(Class<E$$> augmentationType)
-
setBufferId
public FlowAddedBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlowAddedBuilder setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setContainerName
public FlowAddedBuilder setContainerName(String value)
-
setCookie
public FlowAddedBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlowAddedBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlowAddedBuilder setFlags(FlowModFlags value)
-
setFlowName
public FlowAddedBuilder setFlowName(String value)
-
setFlowRef
public FlowAddedBuilder setFlowRef(FlowRef value)
-
setFlowTable
public FlowAddedBuilder setFlowTable(FlowTableRef value)
-
setHardTimeout
public FlowAddedBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlowAddedBuilder setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIdleTimeout
public FlowAddedBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlowAddedBuilder setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInstructions
public FlowAddedBuilder setInstructions(Instructions value)
-
setMatch
public FlowAddedBuilder setMatch(Match value)
-
setNode
public FlowAddedBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setOutGroup
public FlowAddedBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlowAddedBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public FlowAddedBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public FlowAddedBuilder setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutPort(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPriority
public FlowAddedBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlowAddedBuilder setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTableId
public FlowAddedBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public FlowAddedBuilder setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTableId(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTransactionId
public FlowAddedBuilder setTransactionId(TransactionId value)
-
setTransactionUri
public FlowAddedBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
setBarrier
public FlowAddedBuilder setBarrier(Boolean value)
-
setInstallHw
public FlowAddedBuilder setInstallHw(Boolean value)
-
setStrict
public FlowAddedBuilder setStrict(Boolean value)
-
addAugmentation
public FlowAddedBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded> augmentationValue)
-
removeAugmentation
public FlowAddedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> augmentationType)
-
build
public FlowAdded build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowAdded>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowAdded,IllegalArgumentException>
-
-