Class FlowAggregateStatsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.multipart.request.multipart.request.body.multipart.request.flow.aggregate.stats.FlowAggregateStatsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlowAggregateStats>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlowAggregateStats,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlowAggregateStatsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlowAggregateStats>
Class that buildsFlowAggregateStatsBuilder
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:
FlowAggregateStatsBuilder createTarget(int fooXyzzy, int barBaz) { return new FlowAggregateStatsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlowAggregateStatsBuilder, 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:
FlowAggregateStatsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlowAggregateStatsBuilder()
FlowAggregateStatsBuilder(Flow arg)
FlowAggregateStatsBuilder(GenericFlowAttributes arg)
FlowAggregateStatsBuilder(FlowAggregateStats base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlowAggregateStatsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowAggregateStats> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAggregateStats>>
E$$augmentation(Class<E$$> augmentationType)
FlowAggregateStats
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()
Boolean
isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isInstallHw()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isStrict()
Deprecated, for removal: This API element is subject to removal in a future version.FlowAggregateStatsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAggregateStats>> augmentationType)
Remove an augmentation from this builder's product.FlowAggregateStatsBuilder
setBarrier(Boolean value)
FlowAggregateStatsBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.FlowAggregateStatsBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowAggregateStatsBuilder
setContainerName(String value)
FlowAggregateStatsBuilder
setCookie(FlowCookie value)
FlowAggregateStatsBuilder
setCookieMask(FlowCookie value)
FlowAggregateStatsBuilder
setFlags(FlowModFlags value)
FlowAggregateStatsBuilder
setFlowName(String value)
FlowAggregateStatsBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.FlowAggregateStatsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowAggregateStatsBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.FlowAggregateStatsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowAggregateStatsBuilder
setInstallHw(Boolean value)
FlowAggregateStatsBuilder
setInstructions(Instructions value)
FlowAggregateStatsBuilder
setMatch(Match value)
FlowAggregateStatsBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.FlowAggregateStatsBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlowAggregateStatsBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.FlowAggregateStatsBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlowAggregateStatsBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.FlowAggregateStatsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlowAggregateStatsBuilder
setStrict(Boolean value)
FlowAggregateStatsBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.FlowAggregateStatsBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
FlowAggregateStatsBuilder
public FlowAggregateStatsBuilder()
-
FlowAggregateStatsBuilder
public FlowAggregateStatsBuilder(Flow arg)
-
FlowAggregateStatsBuilder
public FlowAggregateStatsBuilder(GenericFlowAttributes arg)
-
FlowAggregateStatsBuilder
public FlowAggregateStatsBuilder(FlowAggregateStats 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 or has property with incompatible value
-
getBarrier
public Boolean getBarrier()
-
isBarrier
@Deprecated(forRemoval=true) public final Boolean isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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()
-
isInstallHw
@Deprecated(forRemoval=true) public final Boolean isInstallHw()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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()
-
isStrict
@Deprecated(forRemoval=true) public final Boolean isStrict()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAggregateStats>> E$$ augmentation(Class<E$$> augmentationType)
-
setBarrier
public FlowAggregateStatsBuilder setBarrier(Boolean value)
-
setBufferId
public FlowAggregateStatsBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setContainerName
public FlowAggregateStatsBuilder setContainerName(String value)
-
setCookie
public FlowAggregateStatsBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlowAggregateStatsBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlowAggregateStatsBuilder setFlags(FlowModFlags value)
-
setFlowName
public FlowAggregateStatsBuilder setFlowName(String value)
-
setHardTimeout
public FlowAggregateStatsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIdleTimeout
public FlowAggregateStatsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInstallHw
public FlowAggregateStatsBuilder setInstallHw(Boolean value)
-
setInstructions
public FlowAggregateStatsBuilder setInstructions(Instructions value)
-
setMatch
public FlowAggregateStatsBuilder setMatch(Match value)
-
setOutGroup
public FlowAggregateStatsBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public FlowAggregateStatsBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPriority
public FlowAggregateStatsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setStrict
public FlowAggregateStatsBuilder setStrict(Boolean value)
-
setTableId
public FlowAggregateStatsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public FlowAggregateStatsBuilder setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public FlowAggregateStatsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlowAggregateStats> 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 FlowAggregateStatsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlowAggregateStats>> 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 FlowAggregateStats build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlowAggregateStats>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlowAggregateStats,IllegalArgumentException>
-
-