Class FlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.FlowBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Flow>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Flow,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Flow>
Class that buildsFlowBuilder
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:
FlowBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowBuilder, 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:
FlowBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowBuilder()
FlowBuilder(Flow base)
FlowBuilder(Flow arg)
FlowBuilder(GenericFlowAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Flow> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Flow>>
E$$augmentation(Class<E$$> augmentationType)
Flow
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.FlowKey
key()
FlowBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Flow>> augmentationType)
Remove an augmentation from this builder's product.FlowBuilder
setBarrier(Boolean value)
FlowBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.FlowBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowBuilder
setContainerName(String value)
FlowBuilder
setCookie(FlowCookie value)
FlowBuilder
setCookieMask(FlowCookie value)
FlowBuilder
setFlags(FlowModFlags value)
FlowBuilder
setFlowName(String value)
FlowBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.FlowBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowBuilder
setId(FlowId value)
FlowBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.FlowBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowBuilder
setInstallHw(Boolean value)
FlowBuilder
setInstructions(Instructions value)
FlowBuilder
setMatch(Match value)
FlowBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.FlowBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.FlowBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.FlowBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowBuilder
setStrict(Boolean value)
FlowBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.FlowBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
FlowBuilder
withKey(FlowKey key)
-
-
-
Constructor Detail
-
FlowBuilder
public FlowBuilder()
-
FlowBuilder
public FlowBuilder(Flow arg)
-
FlowBuilder
public FlowBuilder(GenericFlowAttributes arg)
-
FlowBuilder
public FlowBuilder(Flow 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 FlowKey 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<Flow>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlowBuilder withKey(FlowKey key)
-
setBarrier
public FlowBuilder setBarrier(Boolean value)
-
setBufferId
public FlowBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder setContainerName(String value)
-
setCookie
public FlowBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlowBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlowBuilder setFlags(FlowModFlags value)
-
setFlowName
public FlowBuilder setFlowName(String value)
-
setHardTimeout
public FlowBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder setId(FlowId value)
-
setIdleTimeout
public FlowBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder setInstallHw(Boolean value)
-
setInstructions
public FlowBuilder setInstructions(Instructions value)
-
setMatch
public FlowBuilder setMatch(Match value)
-
setOutGroup
public FlowBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder setStrict(Boolean value)
-
setTableId
public FlowBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public FlowBuilder 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 FlowBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Flow> 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 FlowBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Flow>> 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 Flow build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Flow>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Flow,IllegalArgumentException>
-
-