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