Class FlatBatchRemoveFlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.input.batch.batch.choice.flat.batch.remove.flow._case.FlatBatchRemoveFlowBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveFlow>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchRemoveFlow,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlatBatchRemoveFlowBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveFlow>
Class that buildsFlatBatchRemoveFlowBuilder
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:
FlatBatchRemoveFlowBuilder createTarget(int fooXyzzy, int barBaz) { return new FlatBatchRemoveFlowBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchRemoveFlowBuilder, 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:
FlatBatchRemoveFlowBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchRemoveFlowBuilder()
FlatBatchRemoveFlowBuilder(FlatBatchRemoveFlow base)
FlatBatchRemoveFlowBuilder(Flow arg)
FlatBatchRemoveFlowBuilder(GenericFlowAttributes arg)
FlatBatchRemoveFlowBuilder(BatchFlowIdGrouping arg)
FlatBatchRemoveFlowBuilder(BatchFlowInputGrouping arg)
FlatBatchRemoveFlowBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FlatBatchRemoveFlowBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveFlow> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveFlow>>
E$$augmentation(Class<E$$> augmentationType)
FlatBatchRemoveFlow
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrier()
org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
org.opendaylight.yangtools.yang.common.Uint32
getBufferId()
String
getContainerName()
FlowCookie
getCookie()
FlowCookie
getCookieMask()
FlowModFlags
getFlags()
FlowId
getFlowId()
String
getFlowName()
org.opendaylight.yangtools.yang.common.Uint16
getHardTimeout()
org.opendaylight.yangtools.yang.common.Uint16
getIdleTimeout()
Boolean
getInstallHw()
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()
Boolean
getStrict()
org.opendaylight.yangtools.yang.common.Uint8
getTableId()
Boolean
isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isInstallHw()
Deprecated, for removal: This API element is subject to removal in a future version.Boolean
isStrict()
Deprecated, for removal: This API element is subject to removal in a future version.FlatBatchRemoveFlowKey
key()
FlatBatchRemoveFlowBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveFlow>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchRemoveFlowBuilder
setBarrier(Boolean value)
FlatBatchRemoveFlowBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.FlatBatchRemoveFlowBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchRemoveFlowBuilder
setBufferId(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBufferId(Uint32)
instead.FlatBatchRemoveFlowBuilder
setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
FlatBatchRemoveFlowBuilder
setContainerName(String value)
FlatBatchRemoveFlowBuilder
setCookie(FlowCookie value)
FlatBatchRemoveFlowBuilder
setCookieMask(FlowCookie value)
FlatBatchRemoveFlowBuilder
setFlags(FlowModFlags value)
FlatBatchRemoveFlowBuilder
setFlowId(FlowId value)
FlatBatchRemoveFlowBuilder
setFlowName(String value)
FlatBatchRemoveFlowBuilder
setHardTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetHardTimeout(Uint16)
instead.FlatBatchRemoveFlowBuilder
setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchRemoveFlowBuilder
setIdleTimeout(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIdleTimeout(Uint16)
instead.FlatBatchRemoveFlowBuilder
setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchRemoveFlowBuilder
setInstallHw(Boolean value)
FlatBatchRemoveFlowBuilder
setInstructions(Instructions value)
FlatBatchRemoveFlowBuilder
setMatch(Match value)
FlatBatchRemoveFlowBuilder
setOutGroup(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutGroup(Uint32)
instead.FlatBatchRemoveFlowBuilder
setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
FlatBatchRemoveFlowBuilder
setOutPort(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetOutPort(Uint64)
instead.FlatBatchRemoveFlowBuilder
setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
FlatBatchRemoveFlowBuilder
setPriority(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetPriority(Uint16)
instead.FlatBatchRemoveFlowBuilder
setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
FlatBatchRemoveFlowBuilder
setStrict(Boolean value)
FlatBatchRemoveFlowBuilder
setTableId(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetTableId(Uint8)
instead.FlatBatchRemoveFlowBuilder
setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
FlatBatchRemoveFlowBuilder
withKey(FlatBatchRemoveFlowKey key)
-
-
-
Constructor Detail
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder()
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder(BatchOrderGrouping arg)
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder(BatchFlowInputGrouping arg)
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder(BatchFlowIdGrouping arg)
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder(Flow arg)
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder(GenericFlowAttributes arg)
-
FlatBatchRemoveFlowBuilder
public FlatBatchRemoveFlowBuilder(FlatBatchRemoveFlow 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.flows.service.rev160314.BatchFlowInputGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.GenericFlowAttributes
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.BatchFlowIdGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.service.batch.common.rev160322.BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchRemoveFlowKey key()
-
getBarrier
public Boolean getBarrier()
-
isBarrier
@Deprecated(forRemoval=true) public final Boolean isBarrier()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
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()
-
getFlowId
public FlowId getFlowId()
-
getFlowName
public String getFlowName()
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
-
getInstallHw
public Boolean getInstallHw()
-
isInstallHw
@Deprecated(forRemoval=true) public final Boolean isInstallHw()
Deprecated, for removal: This API element is subject to removal in a future version.
-
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()
-
getStrict
public Boolean getStrict()
-
isStrict
@Deprecated(forRemoval=true) public final Boolean isStrict()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveFlow>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchRemoveFlowBuilder withKey(FlatBatchRemoveFlowKey key)
-
setBarrier
public FlatBatchRemoveFlowBuilder setBarrier(Boolean value)
-
setBatchOrder
public FlatBatchRemoveFlowBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetBatchOrder(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setBufferId
public FlatBatchRemoveFlowBuilder setBufferId(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setBufferId
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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 FlatBatchRemoveFlowBuilder setContainerName(String value)
-
setCookie
public FlatBatchRemoveFlowBuilder setCookie(FlowCookie value)
-
setCookieMask
public FlatBatchRemoveFlowBuilder setCookieMask(FlowCookie value)
-
setFlags
public FlatBatchRemoveFlowBuilder setFlags(FlowModFlags value)
-
setFlowId
public FlatBatchRemoveFlowBuilder setFlowId(FlowId value)
-
setFlowName
public FlatBatchRemoveFlowBuilder setFlowName(String value)
-
setHardTimeout
public FlatBatchRemoveFlowBuilder setHardTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setHardTimeout
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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 FlatBatchRemoveFlowBuilder setIdleTimeout(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setIdleTimeout
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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
-
setInstallHw
public FlatBatchRemoveFlowBuilder setInstallHw(Boolean value)
-
setInstructions
public FlatBatchRemoveFlowBuilder setInstructions(Instructions value)
-
setMatch
public FlatBatchRemoveFlowBuilder setMatch(Match value)
-
setOutGroup
public FlatBatchRemoveFlowBuilder setOutGroup(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setOutGroup
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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 FlatBatchRemoveFlowBuilder setOutPort(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setOutPort
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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 FlatBatchRemoveFlowBuilder setPriority(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setPriority
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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
-
setStrict
public FlatBatchRemoveFlowBuilder setStrict(Boolean value)
-
setTableId
public FlatBatchRemoveFlowBuilder setTableId(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setTableId
@Deprecated(forRemoval=true) public FlatBatchRemoveFlowBuilder 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
-
addAugmentation
public FlatBatchRemoveFlowBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveFlow> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public FlatBatchRemoveFlowBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchRemoveFlow>> 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 FlatBatchRemoveFlow build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchRemoveFlow>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchRemoveFlow,IllegalArgumentException>
-
-