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
-
@Generated("mdsal-binding-generator") public class FlowStatsBuilder extends Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description FlowStatsBuilder()
Construct an empty builder.FlowStatsBuilder(ActionsGrouping arg)
Construct a new builder initialized from specifiedActionsGrouping
.FlowStatsBuilder(InstructionsGrouping arg)
Construct a new builder initialized from specifiedInstructionsGrouping
.FlowStatsBuilder(MatchGrouping arg)
Construct a new builder initialized from specifiedMatchGrouping
.FlowStatsBuilder(MatchV10Grouping arg)
Construct a new builder initialized from specifiedMatchV10Grouping
.FlowStatsBuilder(FlowStats base)
Construct a builder initialized with state from specifiedFlowStats
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull FlowStats
build()
A newFlowStats
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Action>
getAction()
Return current value associated with the property corresponding toActionsGrouping.getAction()
.org.opendaylight.yangtools.yang.common.Uint64
getByteCount()
Return current value associated with the property corresponding toFlowStats.getByteCount()
.org.opendaylight.yangtools.yang.common.Uint64
getCookie()
Return current value associated with the property corresponding toFlowStats.getCookie()
.org.opendaylight.yangtools.yang.common.Uint32
getDurationNsec()
Return current value associated with the property corresponding toFlowStats.getDurationNsec()
.org.opendaylight.yangtools.yang.common.Uint32
getDurationSec()
Return current value associated with the property corresponding toFlowStats.getDurationSec()
.FlowModFlags
getFlags()
Return current value associated with the property corresponding toFlowStats.getFlags()
.org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
Return current value associated with the property corresponding toFlowStats.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Return current value associated with the property corresponding toFlowStats.getIdleTimeout()
.List<Instruction>
getInstruction()
Return current value associated with the property corresponding toInstructionsGrouping.getInstruction()
.Match
getMatch()
Return current value associated with the property corresponding toMatchGrouping.getMatch()
.MatchV10
getMatchV10()
Return current value associated with the property corresponding toMatchV10Grouping.getMatchV10()
.org.opendaylight.yangtools.yang.common.Uint64
getPacketCount()
Return current value associated with the property corresponding toFlowStats.getPacketCount()
.org.opendaylight.yangtools.yang.common.Uint16
getPriority()
Return current value associated with the property corresponding toFlowStats.getPriority()
.org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Return current value associated with the property corresponding toFlowStats.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)
Set the property corresponding toActionsGrouping.getAction()
to the specified value.FlowStatsBuilder
setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowStats.getByteCount()
to the specified value.FlowStatsBuilder
setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowStats.getCookie()
to the specified value.FlowStatsBuilder
setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowStats.getDurationNsec()
to the specified value.FlowStatsBuilder
setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowStats.getDurationSec()
to the specified value.FlowStatsBuilder
setFlags(FlowModFlags value)
Set the property corresponding toFlowStats.getFlags()
to the specified value.FlowStatsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowStats.getHardTimeout()
to the specified value.FlowStatsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowStats.getIdleTimeout()
to the specified value.FlowStatsBuilder
setInstruction(List<Instruction> values)
Set the property corresponding toInstructionsGrouping.getInstruction()
to the specified value.FlowStatsBuilder
setMatch(Match value)
Set the property corresponding toMatchGrouping.getMatch()
to the specified value.FlowStatsBuilder
setMatchV10(MatchV10 value)
Set the property corresponding toMatchV10Grouping.getMatchV10()
to the specified value.FlowStatsBuilder
setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowStats.getPacketCount()
to the specified value.FlowStatsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowStats.getPriority()
to the specified value.FlowStatsBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toFlowStats.getTableId()
to the specified value.
-
-
-
Constructor Detail
-
FlowStatsBuilder
public FlowStatsBuilder()
Construct an empty builder.
-
FlowStatsBuilder
public FlowStatsBuilder(MatchGrouping arg)
Construct a new builder initialized from specifiedMatchGrouping
.- Parameters:
arg
- MatchGrouping from which the builder should be initialized
-
FlowStatsBuilder
public FlowStatsBuilder(InstructionsGrouping arg)
Construct a new builder initialized from specifiedInstructionsGrouping
.- Parameters:
arg
- InstructionsGrouping from which the builder should be initialized
-
FlowStatsBuilder
public FlowStatsBuilder(MatchV10Grouping arg)
Construct a new builder initialized from specifiedMatchV10Grouping
.- Parameters:
arg
- MatchV10Grouping from which the builder should be initialized
-
FlowStatsBuilder
public FlowStatsBuilder(ActionsGrouping arg)
Construct a new builder initialized from specifiedActionsGrouping
.- Parameters:
arg
- ActionsGrouping from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAction
public List<Action> getAction()
Return current value associated with the property corresponding toActionsGrouping.getAction()
.- Returns:
- current value
-
getByteCount
public org.opendaylight.yangtools.yang.common.Uint64 getByteCount()
Return current value associated with the property corresponding toFlowStats.getByteCount()
.- Returns:
- current value
-
getCookie
public org.opendaylight.yangtools.yang.common.Uint64 getCookie()
Return current value associated with the property corresponding toFlowStats.getCookie()
.- Returns:
- current value
-
getDurationNsec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationNsec()
Return current value associated with the property corresponding toFlowStats.getDurationNsec()
.- Returns:
- current value
-
getDurationSec
public org.opendaylight.yangtools.yang.common.Uint32 getDurationSec()
Return current value associated with the property corresponding toFlowStats.getDurationSec()
.- Returns:
- current value
-
getFlags
public FlowModFlags getFlags()
Return current value associated with the property corresponding toFlowStats.getFlags()
.- Returns:
- current value
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
Return current value associated with the property corresponding toFlowStats.getHardTimeout()
.- Returns:
- current value
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
Return current value associated with the property corresponding toFlowStats.getIdleTimeout()
.- Returns:
- current value
-
getInstruction
public List<Instruction> getInstruction()
Return current value associated with the property corresponding toInstructionsGrouping.getInstruction()
.- Returns:
- current value
-
getMatch
public Match getMatch()
Return current value associated with the property corresponding toMatchGrouping.getMatch()
.- Returns:
- current value
-
getMatchV10
public MatchV10 getMatchV10()
Return current value associated with the property corresponding toMatchV10Grouping.getMatchV10()
.- Returns:
- current value
-
getPacketCount
public org.opendaylight.yangtools.yang.common.Uint64 getPacketCount()
Return current value associated with the property corresponding toFlowStats.getPacketCount()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()
Return current value associated with the property corresponding toFlowStats.getPriority()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
Return current value associated with the property corresponding toFlowStats.getTableId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAction
public FlowStatsBuilder setAction(List<Action> values)
Set the property corresponding toActionsGrouping.getAction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setByteCount
public FlowStatsBuilder setByteCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowStats.getByteCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
public FlowStatsBuilder setCookie(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowStats.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDurationNsec
public FlowStatsBuilder setDurationNsec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowStats.getDurationNsec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDurationSec
public FlowStatsBuilder setDurationSec(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toFlowStats.getDurationSec()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
public FlowStatsBuilder setFlags(FlowModFlags value)
Set the property corresponding toFlowStats.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
public FlowStatsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowStats.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
public FlowStatsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowStats.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstruction
public FlowStatsBuilder setInstruction(List<Instruction> values)
Set the property corresponding toInstructionsGrouping.getInstruction()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setMatch
public FlowStatsBuilder setMatch(Match value)
Set the property corresponding toMatchGrouping.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchV10
public FlowStatsBuilder setMatchV10(MatchV10 value)
Set the property corresponding toMatchV10Grouping.getMatchV10()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPacketCount
public FlowStatsBuilder setPacketCount(org.opendaylight.yangtools.yang.common.Uint64 value)
Set the property corresponding toFlowStats.getPacketCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
public FlowStatsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toFlowStats.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
public FlowStatsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toFlowStats.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-