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