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