Class AddFlowInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.service.rev130819.AddFlowInputBuilder
-
@Generated("mdsal-binding-generator") public class AddFlowInputBuilder extends Object
Class that buildsAddFlowInput
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:
AddFlowInput createAddFlowInput(int fooXyzzy, int barBaz) { return new AddFlowInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddFlowInput, 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:
AddFlowInput
- 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 AddFlowInputBuilder()
Construct an empty builder.AddFlowInputBuilder(AddFlowInput base)
Construct a builder initialized with state from specifiedAddFlowInput
.AddFlowInputBuilder(NodeFlow arg)
Construct a new builder initialized from specifiedNodeFlow
.AddFlowInputBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.AddFlowInputBuilder(Flow arg)
Construct a new builder initialized from specifiedFlow
.AddFlowInputBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.AddFlowInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddFlowInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull AddFlowInput
build()
A newAddFlowInput
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 toAddFlowInput.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()
.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()
.AddFlowInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>> augmentationType)
Remove an augmentation from this builder's product.AddFlowInputBuilder
setBarrier(Boolean value)
Set the property corresponding toFlow.getBarrier()
to the specified value.AddFlowInputBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getBufferId()
to the specified value.AddFlowInputBuilder
setContainerName(String value)
Set the property corresponding toFlow.getContainerName()
to the specified value.AddFlowInputBuilder
setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.AddFlowInputBuilder
setCookieMask(FlowCookie value)
Set the property corresponding toFlow.getCookieMask()
to the specified value.AddFlowInputBuilder
setFlags(FlowModFlags value)
Set the property corresponding toFlow.getFlags()
to the specified value.AddFlowInputBuilder
setFlowName(String value)
Set the property corresponding toFlow.getFlowName()
to the specified value.AddFlowInputBuilder
setFlowRef(FlowRef value)
Set the property corresponding toAddFlowInput.getFlowRef()
to the specified value.AddFlowInputBuilder
setFlowTable(FlowTableRef value)
Set the property corresponding toNodeFlow.getFlowTable()
to the specified value.AddFlowInputBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.AddFlowInputBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.AddFlowInputBuilder
setInstallHw(Boolean value)
Set the property corresponding toFlow.getInstallHw()
to the specified value.AddFlowInputBuilder
setInstructions(Instructions value)
Set the property corresponding toFlow.getInstructions()
to the specified value.AddFlowInputBuilder
setMatch(Match value)
Set the property corresponding toFlow.getMatch()
to the specified value.AddFlowInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.AddFlowInputBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getOutGroup()
to the specified value.AddFlowInputBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlow.getOutPort()
to the specified value.AddFlowInputBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.AddFlowInputBuilder
setStrict(Boolean value)
Set the property corresponding toFlow.getStrict()
to the specified value.AddFlowInputBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.AddFlowInputBuilder
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
-
AddFlowInputBuilder
public AddFlowInputBuilder()
Construct an empty builder.
-
AddFlowInputBuilder
public AddFlowInputBuilder(TransactionMetadata arg)
Construct a new builder initialized from specifiedTransactionMetadata
.- Parameters:
arg
- TransactionMetadata from which the builder should be initialized
-
AddFlowInputBuilder
public AddFlowInputBuilder(NodeFlow arg)
Construct a new builder initialized from specifiedNodeFlow
.- Parameters:
arg
- NodeFlow from which the builder should be initialized
-
AddFlowInputBuilder
public AddFlowInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
AddFlowInputBuilder
public AddFlowInputBuilder(Flow arg)
Construct a new builder initialized from specifiedFlow
.- Parameters:
arg
- Flow from which the builder should be initialized
-
AddFlowInputBuilder
public AddFlowInputBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.- Parameters:
arg
- GenericFlowAttributes from which the builder should be initialized
-
AddFlowInputBuilder
public AddFlowInputBuilder(AddFlowInput base)
Construct a builder initialized with state from specifiedAddFlowInput
.- Parameters:
base
- AddFlowInput 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 toAddFlowInput.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
-
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<AddFlowInput>> 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 AddFlowInputBuilder setBarrier(Boolean value)
Set the property corresponding toFlow.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBufferId
public AddFlowInputBuilder 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 AddFlowInputBuilder setContainerName(String value)
Set the property corresponding toFlow.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
public AddFlowInputBuilder setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookieMask
public AddFlowInputBuilder setCookieMask(FlowCookie value)
Set the property corresponding toFlow.getCookieMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public AddFlowInputBuilder setFlags(FlowModFlags value)
Set the property corresponding toFlow.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowName
public AddFlowInputBuilder setFlowName(String value)
Set the property corresponding toFlow.getFlowName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowRef
public AddFlowInputBuilder setFlowRef(FlowRef value)
Set the property corresponding toAddFlowInput.getFlowRef()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowTable
public AddFlowInputBuilder setFlowTable(FlowTableRef value)
Set the property corresponding toNodeFlow.getFlowTable()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
public AddFlowInputBuilder 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 AddFlowInputBuilder 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 AddFlowInputBuilder setInstallHw(Boolean value)
Set the property corresponding toFlow.getInstallHw()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstructions
public AddFlowInputBuilder setInstructions(Instructions value)
Set the property corresponding toFlow.getInstructions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
public AddFlowInputBuilder setMatch(Match value)
Set the property corresponding toFlow.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setNode
public AddFlowInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutGroup
public AddFlowInputBuilder 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 AddFlowInputBuilder 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 AddFlowInputBuilder 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 AddFlowInputBuilder setStrict(Boolean value)
Set the property corresponding toFlow.getStrict()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public AddFlowInputBuilder 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
-
setTransactionUri
public AddFlowInputBuilder 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 AddFlowInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput> 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 AddFlowInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowInput>> 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 @NonNull AddFlowInput build()
A newAddFlowInput
instance.- Returns:
- A new
AddFlowInput
instance.
-
-