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>
@Generated("mdsal-binding-generator") public class FlowStatsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowStats>
Class that buildsFlowStats
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:
FlowStats createFlowStats(int fooXyzzy, int barBaz) { return new FlowStatsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowStats, 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:
FlowStats
,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 Modifier and Type Method Description FlowStatsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats> augmentation)
Add an augmentation to this builder's product.<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)
Remove an augmentation from this builder's product.FlowStatsBuilder
setAction(List<Action> values)
FlowStatsBuilder
setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setFlags(FlowModFlags value)
FlowStatsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setInstruction(List<Instruction> values)
FlowStatsBuilder
setMatch(Match value)
FlowStatsBuilder
setMatchV10(MatchV10 value)
FlowStatsBuilder
setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
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:- MatchV10Grouping
- MatchGrouping
- ActionsGrouping
- InstructionsGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
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)
-
setCookie
public FlowStatsBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDurationNsec
public FlowStatsBuilder setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDurationSec
public FlowStatsBuilder setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setFlags
public FlowStatsBuilder setFlags(FlowModFlags value)
-
setHardTimeout
public FlowStatsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
public FlowStatsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
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)
-
setPriority
public FlowStatsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setTableId
public FlowStatsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
addAugmentation
public FlowStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats> 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 FlowStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> 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 FlowStats build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowStats>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowStats,IllegalArgumentException>
-
-