Class FlowStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.multipart.request.multipart.request.body.multipart.request.flow.stats.FlowStatsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowStats>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowStats,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class FlowStatsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowStats>
Class that buildsFlowStatsBuilder
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:
FlowStatsBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowStatsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowStatsBuilder, 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:
FlowStatsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowStatsBuilder()
FlowStatsBuilder(Flow arg)
FlowStatsBuilder(GenericFlowAttributes arg)
FlowStatsBuilder(FlowStats base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowStatsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>>
E$$augmentation(Class<E$$> augmentationType)
FlowStats
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
String
getFlowName()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
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()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Boolean
isBarrier()
Boolean
isInstallHw()
Boolean
isStrict()
FlowStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> augmentationType)
FlowStatsBuilder
setBarrier(Boolean value)
FlowStatsBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.FlowStatsBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setContainerName(String value)
FlowStatsBuilder
setCookie(FlowCookie value)
FlowStatsBuilder
setCookieMask(FlowCookie value)
FlowStatsBuilder
setFlags(FlowModFlags value)
FlowStatsBuilder
setFlowName(String value)
FlowStatsBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.FlowStatsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.FlowStatsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setInstallHw(Boolean value)
FlowStatsBuilder
setInstructions(Instructions value)
FlowStatsBuilder
setMatch(Match value)
FlowStatsBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.FlowStatsBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutPort(Uint64)} instead.FlowStatsBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.FlowStatsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setStrict(Boolean value)
FlowStatsBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTableId(Uint8)} instead.FlowStatsBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
FlowStatsBuilder
public FlowStatsBuilder()
-
FlowStatsBuilder
public FlowStatsBuilder(Flow arg)
-
FlowStatsBuilder
public FlowStatsBuilder(GenericFlowAttributes arg)
-
FlowStatsBuilder
public FlowStatsBuilder(FlowStats 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
-
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()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
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()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
isBarrier
public Boolean isBarrier()
-
isInstallHw
public Boolean isInstallHw()
-
isStrict
public Boolean isStrict()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> E$$ augmentation(Class<E$$> augmentationType)
-
setBufferId
public FlowStatsBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlowStatsBuilder setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setContainerName
public FlowStatsBuilder setContainerName(String value)
-
setCookie
public FlowStatsBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlowStatsBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlowStatsBuilder setFlags(FlowModFlags value)
-
setFlowName
public FlowStatsBuilder setFlowName(String value)
-
setHardTimeout
public FlowStatsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlowStatsBuilder setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIdleTimeout
public FlowStatsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlowStatsBuilder setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInstructions
public FlowStatsBuilder setInstructions(Instructions value)
-
setMatch
public FlowStatsBuilder setMatch(Match value)
-
setOutGroup
public FlowStatsBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlowStatsBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public FlowStatsBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public FlowStatsBuilder setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutPort(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPriority
public FlowStatsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlowStatsBuilder setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTableId
public FlowStatsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public FlowStatsBuilder setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTableId(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBarrier
public FlowStatsBuilder setBarrier(Boolean value)
-
setInstallHw
public FlowStatsBuilder setInstallHw(Boolean value)
-
setStrict
public FlowStatsBuilder setStrict(Boolean value)
-
addAugmentation
public FlowStatsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats> augmentationValue)
-
removeAugmentation
public FlowStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> augmentationType)
-
build
public FlowStats build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowStats>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowStats,IllegalArgumentException>
-
-