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>
@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(Flow arg)
FlowStatsBuilder(GenericFlowAttributes 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.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()
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()
FlowStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowStats>> augmentationType)
Remove an augmentation from this builder's product.FlowStatsBuilder
setBarrier(Boolean value)
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(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setInstallHw(Boolean value)
FlowStatsBuilder
setInstructions(Instructions value)
FlowStatsBuilder
setMatch(Match value)
FlowStatsBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowStatsBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowStatsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowStatsBuilder
setStrict(Boolean value)
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:- Flow
- GenericFlowAttributes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
-
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()
-
getInstallHw
public Boolean getInstallHw()
-
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()
-
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)
-
setBarrier
public FlowStatsBuilder setBarrier(Boolean value)
-
setBufferId
public FlowStatsBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
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)
-
setIdleTimeout
public FlowStatsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setInstallHw
public FlowStatsBuilder setInstallHw(Boolean value)
-
setInstructions
public FlowStatsBuilder setInstructions(Instructions value)
-
setMatch
public FlowStatsBuilder setMatch(Match value)
-
setOutGroup
public FlowStatsBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutPort
public FlowStatsBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setPriority
public FlowStatsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setStrict
public FlowStatsBuilder setStrict(Boolean 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>
-
-