Class FlowRemovedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowRemovedBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowRemoved>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowRemoved,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowRemovedBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowRemoved>
Class that buildsFlowRemovedBuilder
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:
FlowRemovedBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowRemovedBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowRemovedBuilder, 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:
FlowRemovedBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowRemovedBuilder()
FlowRemovedBuilder(FlowRemoved base)
FlowRemovedBuilder(NodeFlow arg)
FlowRemovedBuilder(TransactionAware arg)
FlowRemovedBuilder(TransactionMetadata arg)
FlowRemovedBuilder(Flow arg)
FlowRemovedBuilder(GenericFlowAttributes arg)
FlowRemovedBuilder(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 FlowRemovedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemoved> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemoved>>
E$$augmentation(Class<E$$> augmentationType)
FlowRemoved
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
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()
Boolean
getInstallHw()
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()
RemovedFlowReason
getReason()
Boolean
getStrict()
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()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isInstallHw()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isStrict()
Deprecated, for removal: This API element is subject to removal in a future version.FlowRemovedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemoved>> augmentationType)
Remove an augmentation from this builder's product.FlowRemovedBuilder
setBarrier(Boolean value)
FlowRemovedBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.FlowRemovedBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowRemovedBuilder
setContainerName(String value)
FlowRemovedBuilder
setCookie(FlowCookie value)
FlowRemovedBuilder
setCookieMask(FlowCookie value)
FlowRemovedBuilder
setFlags(FlowModFlags value)
FlowRemovedBuilder
setFlowName(String value)
FlowRemovedBuilder
setFlowRef(FlowRef value)
FlowRemovedBuilder
setFlowTable(FlowTableRef value)
FlowRemovedBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.FlowRemovedBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowRemovedBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.FlowRemovedBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowRemovedBuilder
setInstallHw(Boolean value)
FlowRemovedBuilder
setInstructions(Instructions value)
FlowRemovedBuilder
setMatch(Match value)
FlowRemovedBuilder
setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
FlowRemovedBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.FlowRemovedBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowRemovedBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.FlowRemovedBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowRemovedBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.FlowRemovedBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowRemovedBuilder
setReason(RemovedFlowReason value)
FlowRemovedBuilder
setStrict(Boolean value)
FlowRemovedBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.FlowRemovedBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowRemovedBuilder
setTransactionId(TransactionId value)
FlowRemovedBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
-
-
Constructor Detail
-
FlowRemovedBuilder
public FlowRemovedBuilder()
-
FlowRemovedBuilder
public FlowRemovedBuilder(TransactionMetadata arg)
-
FlowRemovedBuilder
public FlowRemovedBuilder(NodeFlow arg)
-
FlowRemovedBuilder
public FlowRemovedBuilder(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeContextRef arg)
-
FlowRemovedBuilder
public FlowRemovedBuilder(Flow arg)
-
FlowRemovedBuilder
public FlowRemovedBuilder(GenericFlowAttributes arg)
-
FlowRemovedBuilder
public FlowRemovedBuilder(TransactionAware arg)
-
FlowRemovedBuilder
public FlowRemovedBuilder(FlowRemoved 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 or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
-
isBarrier
@Deprecated(forRemoval=true) public final Boolean isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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()
-
getInstallHw
public Boolean getInstallHw()
-
isInstallHw
@Deprecated(forRemoval=true) public final Boolean isInstallHw()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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()
-
getReason
public RemovedFlowReason getReason()
-
getStrict
public Boolean getStrict()
-
isStrict
@Deprecated(forRemoval=true) public final Boolean isStrict()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemoved>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public FlowRemovedBuilder setBarrier(Boolean value)
-
setBufferId
public FlowRemovedBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlowRemovedBuilder setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setContainerName
public FlowRemovedBuilder setContainerName(String value)
-
setCookie
public FlowRemovedBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlowRemovedBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlowRemovedBuilder setFlags(FlowModFlags value)
-
setFlowName
public FlowRemovedBuilder setFlowName(String value)
-
setFlowRef
public FlowRemovedBuilder setFlowRef(FlowRef value)
-
setFlowTable
public FlowRemovedBuilder setFlowTable(FlowTableRef value)
-
setHardTimeout
public FlowRemovedBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlowRemovedBuilder setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIdleTimeout
public FlowRemovedBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlowRemovedBuilder setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInstallHw
public FlowRemovedBuilder setInstallHw(Boolean value)
-
setInstructions
public FlowRemovedBuilder setInstructions(Instructions value)
-
setMatch
public FlowRemovedBuilder setMatch(Match value)
-
setNode
public FlowRemovedBuilder setNode(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef value)
-
setOutGroup
public FlowRemovedBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlowRemovedBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public FlowRemovedBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public FlowRemovedBuilder setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPriority
public FlowRemovedBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlowRemovedBuilder setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setReason
public FlowRemovedBuilder setReason(RemovedFlowReason value)
-
setStrict
public FlowRemovedBuilder setStrict(Boolean value)
-
setTableId
public FlowRemovedBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public FlowRemovedBuilder setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTransactionId
public FlowRemovedBuilder setTransactionId(TransactionId value)
-
setTransactionUri
public FlowRemovedBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
-
addAugmentation
public FlowRemovedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemoved> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public FlowRemovedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowRemoved>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public FlowRemoved build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowRemoved>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowRemoved,IllegalArgumentException>
-
-