Class FlowStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.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(ActionsGrouping arg)
FlowStatsBuilder(InstructionsGrouping arg)
FlowStatsBuilder(MatchGrouping arg)
FlowStatsBuilder(MatchV10Grouping 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.List<Action>
getAction()
org.opendaylight.yangtools.yang.common.Uint64
getByteCount()
org.opendaylight.yangtools.yang.common.Uint64
getCookie()
org.opendaylight.yangtools.yang.common.Uint32
getDurationNsec()
org.opendaylight.yangtools.yang.common.Uint32
getDurationSec()
FlowModFlags
getFlags()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
List<Instruction>
getInstruction()
Match
getMatch()
MatchV10
getMatchV10()
org.opendaylight.yangtools.yang.common.Uint64
getPacketCount()
org.opendaylight.yangtools.yang.common.Uint16
getPriority()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
FlowStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> augmentationType)
FlowStatsBuilder
setAction(List<Action> values)
FlowStatsBuilder
setByteCount(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setByteCount(Uint64)} instead.FlowStatsBuilder
setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setCookie(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCookie(Uint64)} instead.FlowStatsBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setDurationNsec(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDurationNsec(Uint32)} instead.FlowStatsBuilder
setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setDurationSec(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDurationSec(Uint32)} instead.FlowStatsBuilder
setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setFlags(FlowModFlags 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
setInstruction(List<Instruction> values)
FlowStatsBuilder
setMatch(Match value)
FlowStatsBuilder
setMatchV10(MatchV10 value)
FlowStatsBuilder
setPacketCount(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPacketCount(Uint64)} instead.FlowStatsBuilder
setPacketCount(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
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(MatchGrouping arg)
-
FlowStatsBuilder
public FlowStatsBuilder(InstructionsGrouping arg)
-
FlowStatsBuilder
public FlowStatsBuilder(MatchV10Grouping arg)
-
FlowStatsBuilder
public FlowStatsBuilder(ActionsGrouping 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.openflow.oxm.rev150225.MatchV10Grouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.ActionsGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.InstructionsGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getByteCount
public org.opendaylight.yangtools.yang.common.Uint64 getByteCount()
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
-
getDurationNsec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()
-
getDurationSec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()
-
getFlags
public FlowModFlags getFlags()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getInstruction
public List<Instruction> getInstruction()
-
getMatch
public Match getMatch()
-
getMatchV10
public MatchV10 getMatchV10()
-
getPacketCount
public org.opendaylight.yangtools.yang.common.Uint64 getPacketCount()
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> E$$ augmentation(Class<E$$> augmentationType)
-
setAction
public FlowStatsBuilder setAction(List<Action> values)
-
setByteCount
public FlowStatsBuilder setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setByteCount
@Deprecated(forRemoval=true) public FlowStatsBuilder setByteCount(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setByteCount(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setCookie
public FlowStatsBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setCookie
@Deprecated(forRemoval=true) public FlowStatsBuilder setCookie(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setCookie(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDurationNsec
public FlowStatsBuilder setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDurationNsec
@Deprecated(forRemoval=true) public FlowStatsBuilder setDurationNsec(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDurationNsec(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setDurationSec
public FlowStatsBuilder setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDurationSec
@Deprecated(forRemoval=true) public FlowStatsBuilder setDurationSec(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setDurationSec(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setFlags
public FlowStatsBuilder setFlags(FlowModFlags 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
-
setInstruction
public FlowStatsBuilder setInstruction(List<Instruction> values)
-
setMatch
public FlowStatsBuilder setMatch(Match value)
-
setMatchV10
public FlowStatsBuilder setMatchV10(MatchV10 value)
-
setPacketCount
public FlowStatsBuilder setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPacketCount
@Deprecated(forRemoval=true) public FlowStatsBuilder setPacketCount(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPacketCount(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
-
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>
-
-