Class StaleFlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.StaleFlowBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<StaleFlow>
,org.opendaylight.yangtools.concepts.CheckedBuilder<StaleFlow,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class StaleFlowBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<StaleFlow>
Class that buildsStaleFlowBuilder
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:
StaleFlowBuilder createTarget(int fooXyzzy, int barBaz) { return new StaleFlowBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of StaleFlowBuilder, 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:
StaleFlowBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description StaleFlowBuilder()
StaleFlowBuilder(StaleFlow base)
StaleFlowBuilder(Flow arg)
StaleFlowBuilder(GenericFlowAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated 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)
StaleFlow
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()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
FlowId
getId()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Boolean
getInstallHw()
Instructions
getInstructions()
Match
getMatch()
org.opendaylight.yangtools.yang.common.Uint32
getOutGroup()
org.opendaylight.yangtools.yang.common.Uint64
getOutPort()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Boolean
getStrict()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
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.StaleFlowKey
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)
StaleFlowBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.StaleFlowBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
StaleFlowBuilder
setContainerName(String value)
StaleFlowBuilder
setCookie(FlowCookie value)
StaleFlowBuilder
setCookieMask(FlowCookie value)
StaleFlowBuilder
setFlags(FlowModFlags value)
StaleFlowBuilder
setFlowName(String value)
StaleFlowBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.StaleFlowBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
StaleFlowBuilder
setId(FlowId value)
StaleFlowBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.StaleFlowBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
StaleFlowBuilder
setInstallHw(Boolean value)
StaleFlowBuilder
setInstructions(Instructions value)
StaleFlowBuilder
setMatch(Match value)
StaleFlowBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.StaleFlowBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
StaleFlowBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.StaleFlowBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
StaleFlowBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.StaleFlowBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
StaleFlowBuilder
setStrict(Boolean value)
StaleFlowBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.StaleFlowBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
StaleFlowBuilder
withKey(StaleFlowKey key)
-
-
-
Constructor Detail
-
StaleFlowBuilder
public StaleFlowBuilder()
-
StaleFlowBuilder
public StaleFlowBuilder(Flow arg)
-
StaleFlowBuilder
public StaleFlowBuilder(GenericFlowAttributes arg)
-
StaleFlowBuilder
public StaleFlowBuilder(StaleFlow 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.types.rev131026.Flow
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public StaleFlowKey key()
-
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()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getId
public FlowId getId()
-
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()
-
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()
-
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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<StaleFlow>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public StaleFlowBuilder withKey(StaleFlowKey key)
-
setBarrier
public StaleFlowBuilder setBarrier(Boolean value)
-
setBufferId
public StaleFlowBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public StaleFlowBuilder 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 StaleFlowBuilder setContainerName(String value)
-
setCookie
public StaleFlowBuilder setCookie(FlowCookie value)
-
setCookieMask
public StaleFlowBuilder setCookieMask(FlowCookie value)
-
setFlags
public StaleFlowBuilder setFlags(FlowModFlags value)
-
setFlowName
public StaleFlowBuilder setFlowName(String value)
-
setHardTimeout
public StaleFlowBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public StaleFlowBuilder 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
-
setId
public StaleFlowBuilder setId(FlowId value)
-
setIdleTimeout
public StaleFlowBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public StaleFlowBuilder 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 StaleFlowBuilder setInstallHw(Boolean value)
-
setInstructions
public StaleFlowBuilder setInstructions(Instructions value)
-
setMatch
public StaleFlowBuilder setMatch(Match value)
-
setOutGroup
public StaleFlowBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public StaleFlowBuilder 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 StaleFlowBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public StaleFlowBuilder 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 StaleFlowBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public StaleFlowBuilder 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
-
setStrict
public StaleFlowBuilder setStrict(Boolean value)
-
setTableId
public StaleFlowBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public StaleFlowBuilder 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
-
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
-
build
public StaleFlow build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<StaleFlow>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<StaleFlow,IllegalArgumentException>
-
-