Class AddFlowCaseDataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.onf.bundle.service.rev170124.bundle.inner.message.grouping.bundle.inner.message.bundle.add.flow._case.AddFlowCaseDataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AddFlowCaseData>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AddFlowCaseData,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class AddFlowCaseDataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AddFlowCaseData>
Class that buildsAddFlowCaseDataBuilder
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:
AddFlowCaseDataBuilder createTarget(int fooXyzzy, int barBaz) { return new AddFlowCaseDataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddFlowCaseDataBuilder, 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:
AddFlowCaseDataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddFlowCaseDataBuilder()
AddFlowCaseDataBuilder(Flow arg)
AddFlowCaseDataBuilder(GenericFlowAttributes arg)
AddFlowCaseDataBuilder(AddFlowCaseData base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AddFlowCaseDataBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData>>
E$$augmentation(Class<E$$> augmentationType)
AddFlowCaseData
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()
AddFlowCaseDataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData>> augmentationType)
AddFlowCaseDataBuilder
setBarrier(Boolean value)
AddFlowCaseDataBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.AddFlowCaseDataBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
AddFlowCaseDataBuilder
setContainerName(String value)
AddFlowCaseDataBuilder
setCookie(FlowCookie value)
AddFlowCaseDataBuilder
setCookieMask(FlowCookie value)
AddFlowCaseDataBuilder
setFlags(FlowModFlags value)
AddFlowCaseDataBuilder
setFlowName(String value)
AddFlowCaseDataBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.AddFlowCaseDataBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
AddFlowCaseDataBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.AddFlowCaseDataBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
AddFlowCaseDataBuilder
setInstallHw(Boolean value)
AddFlowCaseDataBuilder
setInstructions(Instructions value)
AddFlowCaseDataBuilder
setMatch(Match value)
AddFlowCaseDataBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.AddFlowCaseDataBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
AddFlowCaseDataBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutPort(Uint64)} instead.AddFlowCaseDataBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
AddFlowCaseDataBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.AddFlowCaseDataBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
AddFlowCaseDataBuilder
setStrict(Boolean value)
AddFlowCaseDataBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTableId(Uint8)} instead.AddFlowCaseDataBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
AddFlowCaseDataBuilder
public AddFlowCaseDataBuilder()
-
AddFlowCaseDataBuilder
public AddFlowCaseDataBuilder(Flow arg)
-
AddFlowCaseDataBuilder
public AddFlowCaseDataBuilder(GenericFlowAttributes arg)
-
AddFlowCaseDataBuilder
public AddFlowCaseDataBuilder(AddFlowCaseData 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<AddFlowCaseData>> E$$ augmentation(Class<E$$> augmentationType)
-
setBufferId
public AddFlowCaseDataBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBufferId(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setContainerName
public AddFlowCaseDataBuilder setContainerName(String value)
-
setCookie
public AddFlowCaseDataBuilder setCookie(FlowCookie value)
-
setCookieMask
public AddFlowCaseDataBuilder setCookieMask(FlowCookie value)
-
setFlags
public AddFlowCaseDataBuilder setFlags(FlowModFlags value)
-
setFlowName
public AddFlowCaseDataBuilder setFlowName(String value)
-
setHardTimeout
public AddFlowCaseDataBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setHardTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIdleTimeout
public AddFlowCaseDataBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setIdleTimeout(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setInstructions
public AddFlowCaseDataBuilder setInstructions(Instructions value)
-
setMatch
public AddFlowCaseDataBuilder setMatch(Match value)
-
setOutGroup
public AddFlowCaseDataBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutGroup(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setOutPort
public AddFlowCaseDataBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setOutPort(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setPriority
public AddFlowCaseDataBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPriority(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTableId
public AddFlowCaseDataBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public AddFlowCaseDataBuilder setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setTableId(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBarrier
public AddFlowCaseDataBuilder setBarrier(Boolean value)
-
setInstallHw
public AddFlowCaseDataBuilder setInstallHw(Boolean value)
-
setStrict
public AddFlowCaseDataBuilder setStrict(Boolean value)
-
addAugmentation
public AddFlowCaseDataBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData> augmentationValue)
-
removeAugmentation
public AddFlowCaseDataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddFlowCaseData>> augmentationType)
-
build
public AddFlowCaseData build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AddFlowCaseData>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AddFlowCaseData,IllegalArgumentException>
-
-