Package org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.update.flows.batch.input
Class BatchUpdateFlowsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.update.flows.batch.input.BatchUpdateFlowsBuilder
-
@Generated("mdsal-binding-generator") public class BatchUpdateFlowsBuilder extends Object
Class that buildsBatchUpdateFlows
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:
BatchUpdateFlows createBatchUpdateFlows(int fooXyzzy, int barBaz) { return new BatchUpdateFlowsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchUpdateFlows, 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:
BatchUpdateFlows
- 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
-
-
Constructor Summary
Constructors Constructor Description BatchUpdateFlowsBuilder()
Construct an empty builder.BatchUpdateFlowsBuilder(BatchFlowIdGrouping arg)
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.BatchUpdateFlowsBuilder(BatchFlowInputUpdateGrouping arg)
Construct a new builder initialized from specifiedBatchFlowInputUpdateGrouping
.BatchUpdateFlowsBuilder(BatchUpdateFlows base)
Construct a builder initialized with state from specifiedBatchUpdateFlows
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchUpdateFlowsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateFlows> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateFlows>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BatchUpdateFlows
build()
A newBatchUpdateFlows
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.FlowId
getFlowId()
Return current value associated with the property corresponding toBatchFlowIdGrouping.getFlowId()
.OriginalBatchedFlow
getOriginalBatchedFlow()
Return current value associated with the property corresponding toBatchFlowInputUpdateGrouping.getOriginalBatchedFlow()
.UpdatedBatchedFlow
getUpdatedBatchedFlow()
Return current value associated with the property corresponding toBatchFlowInputUpdateGrouping.getUpdatedBatchedFlow()
.BatchUpdateFlowsKey
key()
Return current value associated with the property corresponding toBatchUpdateFlows.key()
.BatchUpdateFlowsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateFlows>> augmentationType)
Remove an augmentation from this builder's product.BatchUpdateFlowsBuilder
setFlowId(FlowId value)
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.BatchUpdateFlowsBuilder
setOriginalBatchedFlow(OriginalBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getOriginalBatchedFlow()
to the specified value.BatchUpdateFlowsBuilder
setUpdatedBatchedFlow(UpdatedBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getUpdatedBatchedFlow()
to the specified value.BatchUpdateFlowsBuilder
withKey(BatchUpdateFlowsKey key)
-
-
-
Constructor Detail
-
BatchUpdateFlowsBuilder
public BatchUpdateFlowsBuilder()
Construct an empty builder.
-
BatchUpdateFlowsBuilder
public BatchUpdateFlowsBuilder(BatchFlowInputUpdateGrouping arg)
Construct a new builder initialized from specifiedBatchFlowInputUpdateGrouping
.- Parameters:
arg
- BatchFlowInputUpdateGrouping from which the builder should be initialized
-
BatchUpdateFlowsBuilder
public BatchUpdateFlowsBuilder(BatchFlowIdGrouping arg)
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.- Parameters:
arg
- BatchFlowIdGrouping from which the builder should be initialized
-
BatchUpdateFlowsBuilder
public BatchUpdateFlowsBuilder(BatchUpdateFlows base)
Construct a builder initialized with state from specifiedBatchUpdateFlows
.- Parameters:
base
- BatchUpdateFlows from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public BatchUpdateFlowsKey key()
Return current value associated with the property corresponding toBatchUpdateFlows.key()
.- Returns:
- current value
-
getFlowId
public FlowId getFlowId()
Return current value associated with the property corresponding toBatchFlowIdGrouping.getFlowId()
.- Returns:
- current value
-
getOriginalBatchedFlow
public OriginalBatchedFlow getOriginalBatchedFlow()
Return current value associated with the property corresponding toBatchFlowInputUpdateGrouping.getOriginalBatchedFlow()
.- Returns:
- current value
-
getUpdatedBatchedFlow
public UpdatedBatchedFlow getUpdatedBatchedFlow()
Return current value associated with the property corresponding toBatchFlowInputUpdateGrouping.getUpdatedBatchedFlow()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateFlows>> 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
public BatchUpdateFlowsBuilder withKey(BatchUpdateFlowsKey key)
-
setFlowId
public BatchUpdateFlowsBuilder setFlowId(FlowId value)
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginalBatchedFlow
public BatchUpdateFlowsBuilder setOriginalBatchedFlow(OriginalBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getOriginalBatchedFlow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatedBatchedFlow
public BatchUpdateFlowsBuilder setUpdatedBatchedFlow(UpdatedBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getUpdatedBatchedFlow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BatchUpdateFlowsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateFlows> 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 BatchUpdateFlowsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchUpdateFlows>> 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 @NonNull BatchUpdateFlows build()
A newBatchUpdateFlows
instance.- Returns:
- A new
BatchUpdateFlows
instance.
-
-