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