Class StaleFlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlowBuilder
-
@Generated("mdsal-binding-generator") public class StaleFlowBuilder extends Object
Class that buildsStaleFlow
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:
StaleFlow createStaleFlow(int fooXyzzy, int barBaz) { return new StaleFlowBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StaleFlow, 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:
StaleFlow
- 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 StaleFlowBuilder()
Construct an empty builder.StaleFlowBuilder(StaleFlow base)
Construct a builder initialized with state from specifiedStaleFlow
.StaleFlowBuilder(Flow arg)
Construct a new builder initialized from specifiedFlow
.StaleFlowBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StaleFlowBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull StaleFlow
build()
A newStaleFlow
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()
.org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.FlowId
getId()
Return current value associated with the property corresponding toStaleFlow.getId()
.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()
.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()
.StaleFlowKey
key()
Return current value associated with the property corresponding toStaleFlow.key()
.StaleFlowBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow>> augmentationType)
Remove an augmentation from this builder's product.StaleFlowBuilder
setBarrier(Boolean value)
Set the property corresponding toFlow.getBarrier()
to the specified value.StaleFlowBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getBufferId()
to the specified value.StaleFlowBuilder
setContainerName(String value)
Set the property corresponding toFlow.getContainerName()
to the specified value.StaleFlowBuilder
setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.StaleFlowBuilder
setCookieMask(FlowCookie value)
Set the property corresponding toFlow.getCookieMask()
to the specified value.StaleFlowBuilder
setFlags(FlowModFlags value)
Set the property corresponding toFlow.getFlags()
to the specified value.StaleFlowBuilder
setFlowName(String value)
Set the property corresponding toFlow.getFlowName()
to the specified value.StaleFlowBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.StaleFlowBuilder
setId(FlowId value)
Set the property corresponding toStaleFlow.getId()
to the specified value.StaleFlowBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.StaleFlowBuilder
setInstallHw(Boolean value)
Set the property corresponding toFlow.getInstallHw()
to the specified value.StaleFlowBuilder
setInstructions(Instructions value)
Set the property corresponding toFlow.getInstructions()
to the specified value.StaleFlowBuilder
setMatch(Match value)
Set the property corresponding toFlow.getMatch()
to the specified value.StaleFlowBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlow.getOutGroup()
to the specified value.StaleFlowBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlow.getOutPort()
to the specified value.StaleFlowBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.StaleFlowBuilder
setStrict(Boolean value)
Set the property corresponding toFlow.getStrict()
to the specified value.StaleFlowBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.StaleFlowBuilder
withKey(StaleFlowKey key)
-
-
-
Constructor Detail
-
StaleFlowBuilder
public StaleFlowBuilder()
Construct an empty builder.
-
StaleFlowBuilder
public StaleFlowBuilder(Flow arg)
Construct a new builder initialized from specifiedFlow
.- Parameters:
arg
- Flow from which the builder should be initialized
-
StaleFlowBuilder
public StaleFlowBuilder(GenericFlowAttributes arg)
Construct a new builder initialized from specifiedGenericFlowAttributes
.- Parameters:
arg
- GenericFlowAttributes 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
-
key
public StaleFlowKey key()
Return current value associated with the property corresponding toStaleFlow.key()
.- Returns:
- current 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
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.- Returns:
- current value
-
getId
public FlowId getId()
Return current value associated with the property corresponding toStaleFlow.getId()
.- 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
-
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
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow>> 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
-
withKey
public StaleFlowBuilder withKey(StaleFlowKey key)
-
setBarrier
public StaleFlowBuilder setBarrier(Boolean value)
Set the property corresponding toFlow.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBufferId
public StaleFlowBuilder 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 StaleFlowBuilder setContainerName(String value)
Set the property corresponding toFlow.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
public StaleFlowBuilder setCookie(FlowCookie value)
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookieMask
public StaleFlowBuilder setCookieMask(FlowCookie value)
Set the property corresponding toFlow.getCookieMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public StaleFlowBuilder setFlags(FlowModFlags value)
Set the property corresponding toFlow.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowName
public StaleFlowBuilder setFlowName(String value)
Set the property corresponding toFlow.getFlowName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
public StaleFlowBuilder 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
-
setId
public StaleFlowBuilder setId(FlowId value)
Set the property corresponding toStaleFlow.getId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
public StaleFlowBuilder 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 StaleFlowBuilder setInstallHw(Boolean value)
Set the property corresponding toFlow.getInstallHw()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstructions
public StaleFlowBuilder setInstructions(Instructions value)
Set the property corresponding toFlow.getInstructions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
public StaleFlowBuilder setMatch(Match value)
Set the property corresponding toFlow.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutGroup
public StaleFlowBuilder 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 StaleFlowBuilder 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 StaleFlowBuilder 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 StaleFlowBuilder setStrict(Boolean value)
Set the property corresponding toFlow.getStrict()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public StaleFlowBuilder 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
-
addAugmentation
public StaleFlowBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow> 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 StaleFlowBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow>> 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
-
-