Package org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.remove.flows.batch.input
Class BatchRemoveFlowsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.remove.flows.batch.input.BatchRemoveFlowsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchRemoveFlows>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveFlows,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchRemoveFlowsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchRemoveFlows>
Class that buildsBatchRemoveFlowsBuilder
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:
BatchRemoveFlowsBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchRemoveFlowsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchRemoveFlowsBuilder, 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:
BatchRemoveFlowsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchRemoveFlowsBuilder()
BatchRemoveFlowsBuilder(Flow arg)
BatchRemoveFlowsBuilder(GenericFlowAttributes arg)
BatchRemoveFlowsBuilder(BatchFlowIdGrouping arg)
BatchRemoveFlowsBuilder(BatchFlowInputGrouping arg)
BatchRemoveFlowsBuilder(BatchRemoveFlows base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchRemoveFlowsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BatchRemoveFlowsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>>
E$$augmentation(Class<E$$> augmentationType)
BatchRemoveFlows
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
FlowId
getFlowId()
String
getFlowName()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
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()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Boolean
isBarrier()
Boolean
isInstallHw()
Boolean
isStrict()
BatchRemoveFlowsKey
key()
BatchRemoveFlowsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> augmentationType)
Remove an augmentation from this builder's product.BatchRemoveFlowsBuilder
setBarrier(Boolean value)
BatchRemoveFlowsBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.BatchRemoveFlowsBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
BatchRemoveFlowsBuilder
setContainerName(String value)
BatchRemoveFlowsBuilder
setCookie(FlowCookie value)
BatchRemoveFlowsBuilder
setCookieMask(FlowCookie value)
BatchRemoveFlowsBuilder
setFlags(FlowModFlags value)
BatchRemoveFlowsBuilder
setFlowId(FlowId value)
BatchRemoveFlowsBuilder
setFlowName(String value)
BatchRemoveFlowsBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.BatchRemoveFlowsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchRemoveFlowsBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.BatchRemoveFlowsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchRemoveFlowsBuilder
setInstallHw(Boolean value)
BatchRemoveFlowsBuilder
setInstructions(Instructions value)
BatchRemoveFlowsBuilder
setMatch(Match value)
BatchRemoveFlowsBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.BatchRemoveFlowsBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BatchRemoveFlowsBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.BatchRemoveFlowsBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
BatchRemoveFlowsBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.BatchRemoveFlowsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchRemoveFlowsBuilder
setStrict(Boolean value)
BatchRemoveFlowsBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.BatchRemoveFlowsBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
BatchRemoveFlowsBuilder
withKey(BatchRemoveFlowsKey key)
-
-
-
Constructor Detail
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder()
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(BatchFlowInputGrouping arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(BatchFlowIdGrouping arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(Flow arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(GenericFlowAttributes arg)
-
BatchRemoveFlowsBuilder
public BatchRemoveFlowsBuilder(BatchRemoveFlows 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.flows.service.rev160314.BatchFlowInputGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public BatchRemoveFlowsKey key()
-
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()
-
getFlowId
public FlowId getFlowId()
-
getFlowName
public String getFlowName()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
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()
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
isBarrier
public Boolean isBarrier()
-
isInstallHw
public Boolean isInstallHw()
-
isStrict
public Boolean isStrict()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchRemoveFlowsBuilder withKey(BatchRemoveFlowsKey key)
-
setBufferId
public BatchRemoveFlowsBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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 BatchRemoveFlowsBuilder setContainerName(String value)
-
setCookie
public BatchRemoveFlowsBuilder setCookie(FlowCookie value)
-
setCookieMask
public BatchRemoveFlowsBuilder setCookieMask(FlowCookie value)
-
setFlags
public BatchRemoveFlowsBuilder setFlags(FlowModFlags value)
-
setFlowId
public BatchRemoveFlowsBuilder setFlowId(FlowId value)
-
setFlowName
public BatchRemoveFlowsBuilder setFlowName(String value)
-
setHardTimeout
public BatchRemoveFlowsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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 BatchRemoveFlowsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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
-
setInstructions
public BatchRemoveFlowsBuilder setInstructions(Instructions value)
-
setMatch
public BatchRemoveFlowsBuilder setMatch(Match value)
-
setOutGroup
public BatchRemoveFlowsBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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 BatchRemoveFlowsBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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 BatchRemoveFlowsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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
-
setTableId
public BatchRemoveFlowsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder 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
-
setBarrier
public BatchRemoveFlowsBuilder setBarrier(Boolean value)
-
setInstallHw
public BatchRemoveFlowsBuilder setInstallHw(Boolean value)
-
setStrict
public BatchRemoveFlowsBuilder setStrict(Boolean value)
-
addAugmentation
public BatchRemoveFlowsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public BatchRemoveFlowsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public BatchRemoveFlowsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchRemoveFlows>> 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 BatchRemoveFlows build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchRemoveFlows>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchRemoveFlows,IllegalArgumentException>
-
-