Class BatchAddFlowsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.add.flows.batch.input.BatchAddFlowsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchAddFlows>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchAddFlows,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchAddFlowsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchAddFlows>
Class that buildsBatchAddFlowsBuilder
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:
BatchAddFlowsBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchAddFlowsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchAddFlowsBuilder, 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:
BatchAddFlowsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchAddFlowsBuilder()
BatchAddFlowsBuilder(Flow arg)
BatchAddFlowsBuilder(GenericFlowAttributes arg)
BatchAddFlowsBuilder(BatchAddFlows base)
BatchAddFlowsBuilder(BatchFlowIdGrouping arg)
BatchAddFlowsBuilder(BatchFlowInputGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchAddFlowsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.BatchAddFlowsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>>
E$$augmentation(Class<E$$> augmentationType)
BatchAddFlows
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()
BatchAddFlowsKey
key()
BatchAddFlowsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> augmentationType)
Remove an augmentation from this builder's product.BatchAddFlowsBuilder
setBarrier(Boolean value)
BatchAddFlowsBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.BatchAddFlowsBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
BatchAddFlowsBuilder
setContainerName(String value)
BatchAddFlowsBuilder
setCookie(FlowCookie value)
BatchAddFlowsBuilder
setCookieMask(FlowCookie value)
BatchAddFlowsBuilder
setFlags(FlowModFlags value)
BatchAddFlowsBuilder
setFlowId(FlowId value)
BatchAddFlowsBuilder
setFlowName(String value)
BatchAddFlowsBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.BatchAddFlowsBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchAddFlowsBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.BatchAddFlowsBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchAddFlowsBuilder
setInstallHw(Boolean value)
BatchAddFlowsBuilder
setInstructions(Instructions value)
BatchAddFlowsBuilder
setMatch(Match value)
BatchAddFlowsBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.BatchAddFlowsBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
BatchAddFlowsBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.BatchAddFlowsBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
BatchAddFlowsBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.BatchAddFlowsBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchAddFlowsBuilder
setStrict(Boolean value)
BatchAddFlowsBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.BatchAddFlowsBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
BatchAddFlowsBuilder
withKey(BatchAddFlowsKey key)
-
-
-
Constructor Detail
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder()
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder(BatchFlowInputGrouping arg)
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder(BatchFlowIdGrouping arg)
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder(Flow arg)
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder(GenericFlowAttributes arg)
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder(BatchAddFlows 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 BatchAddFlowsKey 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<BatchAddFlows>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchAddFlowsBuilder withKey(BatchAddFlowsKey key)
-
setBufferId
public BatchAddFlowsBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setContainerName(String value)
-
setCookie
public BatchAddFlowsBuilder setCookie(FlowCookie value)
-
setCookieMask
public BatchAddFlowsBuilder setCookieMask(FlowCookie value)
-
setFlags
public BatchAddFlowsBuilder setFlags(FlowModFlags value)
-
setFlowId
public BatchAddFlowsBuilder setFlowId(FlowId value)
-
setFlowName
public BatchAddFlowsBuilder setFlowName(String value)
-
setHardTimeout
public BatchAddFlowsBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setInstructions(Instructions value)
-
setMatch
public BatchAddFlowsBuilder setMatch(Match value)
-
setOutGroup
public BatchAddFlowsBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public BatchAddFlowsBuilder 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 BatchAddFlowsBuilder setBarrier(Boolean value)
-
setInstallHw
public BatchAddFlowsBuilder setInstallHw(Boolean value)
-
setStrict
public BatchAddFlowsBuilder setStrict(Boolean value)
-
addAugmentation
public BatchAddFlowsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows> 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 BatchAddFlowsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows> 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 BatchAddFlowsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> 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 BatchAddFlows build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchAddFlows>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchAddFlows,IllegalArgumentException>
-
-