Class FlowAddedBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.FlowAddedBuilder
-
@Generated("mdsal-binding-generator") public class FlowAddedBuilder extends Object
Class that buildsFlowAdded
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:
FlowAdded createFlowAdded(int fooXyzzy, int barBaz) { return new FlowAddedBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowAdded, 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 opportunities, 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:
FlowAdded
- 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
-
-
Constructor Summary
Constructors Constructor Description FlowAddedBuilder()
Construct an empty builder.FlowAddedBuilder(FlowAdded base)
Construct a builder initialized with state from specifiedFlowAdded
.FlowAddedBuilder(NodeFlow arg)
Construct a new builder initialized from specifiedNodeFlow
.FlowAddedBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.FlowAddedBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.FlowAddedBuilder(Flow arg)
Construct a new builder initialized from specifiedFlow
.FlowAddedBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.FlowAddedBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlowAddedBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlowAdded
build()
A newFlowAdded
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
Return current value associated with the property corresponding toFlow.getBarrier()
.org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
Return current value associated with the property corresponding toFlow.getBufferId()
.String
getContainerName()
Return current value associated with the property corresponding toFlow.getContainerName()
.FlowCookie
getCookie()
Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.FlowCookie
getCookieMask()
Return current value associated with the property corresponding toFlow.getCookieMask()
.FlowModFlags
getFlags()
Return current value associated with the property corresponding toFlow.getFlags()
.String
getFlowName()
Return current value associated with the property corresponding toFlow.getFlowName()
.FlowRef
getFlowRef()
Return current value associated with the property corresponding toFlowAdded.getFlowRef()
.FlowTableRef
getFlowTable()
Return current value associated with the property corresponding toNodeFlow.getFlowTable()
.org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.Boolean
getInstallHw()
Return current value associated with the property corresponding toFlow.getInstallHw()
.Instructions
getInstructions()
Return current value associated with the property corresponding toFlow.getInstructions()
.Match
getMatch()
Return current value associated with the property corresponding toFlow.getMatch()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
Return current value associated with the property corresponding toFlow.getOutGroup()
.org.opendaylight.yangtools.yang.common.Uint64
getOutPort()
Return current value associated with the property corresponding toFlow.getOutPort()
.org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.Boolean
getStrict()
Return current value associated with the property corresponding toFlow.getStrict()
.org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.TransactionId
getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri
getTransactionUri()
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.FlowAddedBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> augmentationType)
Remove an augmentation from this builder's product.FlowAddedBuilder
setBarrier(Boolean value)
Set the property corresponding toFlow.getBarrier()
to the specified value.FlowAddedBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getBufferId()
to the specified value.FlowAddedBuilder
setContainerName(String value)
Set the property corresponding toFlow.getContainerName()
to the specified value.FlowAddedBuilder
setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.FlowAddedBuilder
setCookieMask(FlowCookie value)
Set the property corresponding toFlow.getCookieMask()
to the specified value.FlowAddedBuilder
setFlags(FlowModFlags value)
Set the property corresponding toFlow.getFlags()
to the specified value.FlowAddedBuilder
setFlowName(String value)
Set the property corresponding toFlow.getFlowName()
to the specified value.FlowAddedBuilder
setFlowRef(FlowRef value)
Set the property corresponding toFlowAdded.getFlowRef()
to the specified value.FlowAddedBuilder
setFlowTable(FlowTableRef value)
Set the property corresponding toNodeFlow.getFlowTable()
to the specified value.FlowAddedBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.FlowAddedBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.FlowAddedBuilder
setInstallHw(Boolean value)
Set the property corresponding toFlow.getInstallHw()
to the specified value.FlowAddedBuilder
setInstructions(Instructions value)
Set the property corresponding toFlow.getInstructions()
to the specified value.FlowAddedBuilder
setMatch(Match value)
Set the property corresponding toFlow.getMatch()
to the specified value.FlowAddedBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.FlowAddedBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getOutGroup()
to the specified value.FlowAddedBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlow.getOutPort()
to the specified value.FlowAddedBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.FlowAddedBuilder
setStrict(Boolean value)
Set the property corresponding toFlow.getStrict()
to the specified value.FlowAddedBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.FlowAddedBuilder
setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.FlowAddedBuilder
setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.
-
-
-
Constructor Detail
-
FlowAddedBuilder
public FlowAddedBuilder()
Construct an empty builder.
-
FlowAddedBuilder
public FlowAddedBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.- Parameters:
arg
- TransactionMetadata from which the builder should be initialized
-
FlowAddedBuilder
public FlowAddedBuilder(NodeFlow arg)
Construct a new builder initialized from specifiedNodeFlow
.- Parameters:
arg
- NodeFlow from which the builder should be initialized
-
FlowAddedBuilder
public FlowAddedBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
FlowAddedBuilder
public FlowAddedBuilder(Flow arg)
Construct a new builder initialized from specifiedFlow
.- Parameters:
arg
- Flow from which the builder should be initialized
-
FlowAddedBuilder
public FlowAddedBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.- Parameters:
arg
- GenericFlowAttributes from which the builder should be initialized
-
FlowAddedBuilder
public FlowAddedBuilder(TransactionAware arg)
Construct a new builder initialized from specifiedTransactionAware
.- Parameters:
arg
- TransactionAware from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
Return current value associated with the property corresponding toFlow.getBarrier()
.- Returns:
- current value
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()
Return current value associated with the property corresponding toFlow.getBufferId()
.- Returns:
- current value
-
getContainerName
public String getContainerName()
Return current value associated with the property corresponding toFlow.getContainerName()
.- Returns:
- current value
-
getCookie
public FlowCookie getCookie()
Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.- Returns:
- current value
-
getCookieMask
public FlowCookie getCookieMask()
Return current value associated with the property corresponding toFlow.getCookieMask()
.- Returns:
- current value
-
getFlags
public FlowModFlags getFlags()
Return current value associated with the property corresponding toFlow.getFlags()
.- Returns:
- current value
-
getFlowName
public String getFlowName()
Return current value associated with the property corresponding toFlow.getFlowName()
.- Returns:
- current value
-
getFlowRef
public FlowRef getFlowRef()
Return current value associated with the property corresponding toFlowAdded.getFlowRef()
.- Returns:
- current value
-
getFlowTable
public FlowTableRef getFlowTable()
Return current value associated with the property corresponding toNodeFlow.getFlowTable()
.- Returns:
- current value
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.- Returns:
- current value
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.- Returns:
- current value
-
getInstallHw
public Boolean getInstallHw()
Return current value associated with the property corresponding toFlow.getInstallHw()
.- Returns:
- current value
-
getInstructions
public Instructions getInstructions()
Return current value associated with the property corresponding toFlow.getInstructions()
.- Returns:
- current value
-
getMatch
public Match getMatch()
Return current value associated with the property corresponding toFlow.getMatch()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()
Return current value associated with the property corresponding toFlow.getOutGroup()
.- Returns:
- current value
-
getOutPort
public org.opendaylight.yangtools.yang.common.Uint64 getOutPort()
Return current value associated with the property corresponding toFlow.getOutPort()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.- Returns:
- current value
-
getStrict
public Boolean getStrict()
Return current value associated with the property corresponding toFlow.getStrict()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.- Returns:
- current value
-
getTransactionId
public TransactionId getTransactionId()
Return current value associated with the property corresponding toTransactionAware.getTransactionId()
.- Returns:
- current value
-
getTransactionUri
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri getTransactionUri()
Return current value associated with the property corresponding toTransactionMetadata.getTransactionUri()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBarrier
public FlowAddedBuilder setBarrier(Boolean value)
Set the property corresponding toFlow.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBufferId
public FlowAddedBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getBufferId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
public FlowAddedBuilder setContainerName(String value)
Set the property corresponding toFlow.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
public FlowAddedBuilder setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookieMask
public FlowAddedBuilder setCookieMask(FlowCookie value)
Set the property corresponding toFlow.getCookieMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public FlowAddedBuilder setFlags(FlowModFlags value)
Set the property corresponding toFlow.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowName
public FlowAddedBuilder setFlowName(String value)
Set the property corresponding toFlow.getFlowName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowRef
public FlowAddedBuilder setFlowRef(FlowRef value)
Set the property corresponding toFlowAdded.getFlowRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowTable
public FlowAddedBuilder setFlowTable(FlowTableRef value)
Set the property corresponding toNodeFlow.getFlowTable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
public FlowAddedBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
public FlowAddedBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstallHw
public FlowAddedBuilder setInstallHw(Boolean value)
Set the property corresponding toFlow.getInstallHw()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstructions
public FlowAddedBuilder setInstructions(Instructions value)
Set the property corresponding toFlow.getInstructions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
public FlowAddedBuilder setMatch(Match value)
Set the property corresponding toFlow.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public FlowAddedBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutGroup
public FlowAddedBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getOutGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutPort
public FlowAddedBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlow.getOutPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
public FlowAddedBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStrict
public FlowAddedBuilder setStrict(Boolean value)
Set the property corresponding toFlow.getStrict()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public FlowAddedBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionId
public FlowAddedBuilder setTransactionId(TransactionId value)
Set the property corresponding toTransactionAware.getTransactionId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTransactionUri
public FlowAddedBuilder setTransactionUri(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Uri value)
Set the property corresponding toTransactionMetadata.getTransactionUri()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlowAddedBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded> 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 FlowAddedBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAdded>> 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
-
-