Class BatchAddFlowsBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.add.flows.batch.input.BatchAddFlowsBuilder
Class that builds
BatchAddFlows
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:
BatchAddFlows createBatchAddFlows(int fooXyzzy, int barBaz) {
return new BatchAddFlowsBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of BatchAddFlows, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.BatchAddFlowsBuilder
(Flow arg) Construct a new builder initialized from specifiedFlow
.Construct a new builder initialized from specifiedGenericFlowAttributes
.Construct a builder initialized with state from specifiedBatchAddFlows
.Construct a new builder initialized from specifiedBatchFlowIdGrouping
.Construct a new builder initialized from specifiedBatchFlowInputGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull BatchAddFlows
build()
A newBatchAddFlows
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toFlow.getBarrier()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlow.getBufferId()
.Return current value associated with the property corresponding toFlow.getContainerName()
.Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.Return current value associated with the property corresponding toFlow.getCookieMask()
.getFlags()
Return current value associated with the property corresponding toFlow.getFlags()
.Return current value associated with the property corresponding toBatchFlowIdGrouping.getFlowId()
.Return current value associated with the property corresponding toFlow.getFlowName()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.Return current value associated with the property corresponding toFlow.getInstallHw()
.Return current value associated with the property corresponding toFlow.getInstructions()
.getMatch()
Return current value associated with the property corresponding toFlow.getMatch()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toFlow.getOutGroup()
.org.opendaylight.yangtools.yang.common.Uint64
Return current value associated with the property corresponding toFlow.getOutPort()
.org.opendaylight.yangtools.yang.common.Uint16
Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.Return current value associated with the property corresponding toFlow.getStrict()
.org.opendaylight.yangtools.yang.common.Uint8
Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.key()
Return current value associated with the property corresponding toBatchAddFlows.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> augmentationType) Remove an augmentation from this builder's product.setBarrier
(Boolean value) Set the property corresponding toFlow.getBarrier()
to the specified value.setBufferId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlow.getBufferId()
to the specified value.setContainerName
(String value) Set the property corresponding toFlow.getContainerName()
to the specified value.setCookie
(FlowCookie value) Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.setCookieMask
(FlowCookie value) Set the property corresponding toFlow.getCookieMask()
to the specified value.setFlags
(FlowModFlags value) Set the property corresponding toFlow.getFlags()
to the specified value.Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.setFlowName
(String value) Set the property corresponding toFlow.getFlowName()
to the specified value.setHardTimeout
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.setIdleTimeout
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.setInstallHw
(Boolean value) Set the property corresponding toFlow.getInstallHw()
to the specified value.setInstructions
(Instructions value) Set the property corresponding toFlow.getInstructions()
to the specified value.Set the property corresponding toFlow.getMatch()
to the specified value.setOutGroup
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toFlow.getOutGroup()
to the specified value.setOutPort
(org.opendaylight.yangtools.yang.common.Uint64 value) Set the property corresponding toFlow.getOutPort()
to the specified value.setPriority
(org.opendaylight.yangtools.yang.common.Uint16 value) Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.Set the property corresponding toFlow.getStrict()
to the specified value.setTableId
(org.opendaylight.yangtools.yang.common.Uint8 value) Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.withKey
(BatchAddFlowsKey key) Set the key value corresponding toBatchAddFlows.key()
to the specified value.
-
Constructor Details
-
BatchAddFlowsBuilder
public BatchAddFlowsBuilder()Construct an empty builder. -
BatchAddFlowsBuilder
Construct a new builder initialized from specifiedBatchFlowInputGrouping
.- Parameters:
arg
- BatchFlowInputGrouping from which the builder should be initialized
-
BatchAddFlowsBuilder
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.- Parameters:
arg
- BatchFlowIdGrouping from which the builder should be initialized
-
BatchAddFlowsBuilder
Construct a new builder initialized from specifiedFlow
.- Parameters:
arg
- Flow from which the builder should be initialized
-
BatchAddFlowsBuilder
Construct a new builder initialized from specifiedGenericFlowAttributes
.- Parameters:
arg
- GenericFlowAttributes from which the builder should be initialized
-
BatchAddFlowsBuilder
Construct a builder initialized with state from specifiedBatchAddFlows
.- Parameters:
base
- BatchAddFlows from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
Return current value associated with the property corresponding toBatchAddFlows.key()
.- Returns:
- current value
-
getBarrier
Return current value associated with the property corresponding toFlow.getBarrier()
.- Returns:
- current value
-
getBufferId
public org.opendaylight.yangtools.yang.common.Uint32 getBufferId()Return current value associated with the property corresponding toFlow.getBufferId()
.- Returns:
- current value
-
getContainerName
Return current value associated with the property corresponding toFlow.getContainerName()
.- Returns:
- current value
-
getCookie
Return current value associated with the property corresponding toGenericFlowAttributes.getCookie()
.- Returns:
- current value
-
getCookieMask
Return current value associated with the property corresponding toFlow.getCookieMask()
.- Returns:
- current value
-
getFlags
Return current value associated with the property corresponding toFlow.getFlags()
.- Returns:
- current value
-
getFlowId
Return current value associated with the property corresponding toBatchFlowIdGrouping.getFlowId()
.- Returns:
- current value
-
getFlowName
Return current value associated with the property corresponding toFlow.getFlowName()
.- Returns:
- current value
-
getHardTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()Return current value associated with the property corresponding toGenericFlowAttributes.getHardTimeout()
.- Returns:
- current value
-
getIdleTimeout
public org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()Return current value associated with the property corresponding toGenericFlowAttributes.getIdleTimeout()
.- Returns:
- current value
-
getInstallHw
Return current value associated with the property corresponding toFlow.getInstallHw()
.- Returns:
- current value
-
getInstructions
Return current value associated with the property corresponding toFlow.getInstructions()
.- Returns:
- current value
-
getMatch
Return current value associated with the property corresponding toFlow.getMatch()
.- Returns:
- current value
-
getOutGroup
public org.opendaylight.yangtools.yang.common.Uint32 getOutGroup()Return current value associated with the property corresponding toFlow.getOutGroup()
.- Returns:
- current value
-
getOutPort
public org.opendaylight.yangtools.yang.common.Uint64 getOutPort()Return current value associated with the property corresponding toFlow.getOutPort()
.- Returns:
- current value
-
getPriority
public org.opendaylight.yangtools.yang.common.Uint16 getPriority()Return current value associated with the property corresponding toGenericFlowAttributes.getPriority()
.- Returns:
- current value
-
getStrict
Return current value associated with the property corresponding toFlow.getStrict()
.- Returns:
- current value
-
getTableId
public org.opendaylight.yangtools.yang.common.Uint8 getTableId()Return current value associated with the property corresponding toGenericFlowAttributes.getTableId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
withKey
Set the key value corresponding toBatchAddFlows.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setBarrier
Set the property corresponding toFlow.getBarrier()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBufferId
Set the property corresponding toFlow.getBufferId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setContainerName
Set the property corresponding toFlow.getContainerName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookie
Set the property corresponding toGenericFlowAttributes.getCookie()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCookieMask
Set the property corresponding toFlow.getCookieMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlags
Set the property corresponding toFlow.getFlags()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowId
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowName
Set the property corresponding toFlow.getFlowName()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHardTimeout
Set the property corresponding toGenericFlowAttributes.getHardTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIdleTimeout
Set the property corresponding toGenericFlowAttributes.getIdleTimeout()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstallHw
Set the property corresponding toFlow.getInstallHw()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setInstructions
Set the property corresponding toFlow.getInstructions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatch
Set the property corresponding toFlow.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutGroup
Set the property corresponding toFlow.getOutGroup()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOutPort
Set the property corresponding toFlow.getOutPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPriority
Set the property corresponding toGenericFlowAttributes.getPriority()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setStrict
Set the property corresponding toFlow.getStrict()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTableId
Set the property corresponding toGenericFlowAttributes.getTableId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BatchAddFlowsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows> 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 BatchAddFlowsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchAddFlows>> 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
A newBatchAddFlows
instance.- Returns:
- A new
BatchAddFlows
instance.
-