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