Class FlatBatchUpdateFlowBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.flow.crud._case.aug.flat.batch.update.flow._case.FlatBatchUpdateFlowBuilder
-
@Generated("mdsal-binding-generator") public class FlatBatchUpdateFlowBuilder extends Object
Class that buildsFlatBatchUpdateFlow
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:
FlatBatchUpdateFlow createFlatBatchUpdateFlow(int fooXyzzy, int barBaz) { return new FlatBatchUpdateFlowBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchUpdateFlow, 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:
FlatBatchUpdateFlow
- 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 FlatBatchUpdateFlowBuilder()
Construct an empty builder.FlatBatchUpdateFlowBuilder(FlatBatchUpdateFlow base)
Construct a builder initialized with state from specifiedFlatBatchUpdateFlow
.FlatBatchUpdateFlowBuilder(BatchFlowIdGrouping arg)
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.FlatBatchUpdateFlowBuilder(BatchFlowInputUpdateGrouping arg)
Construct a new builder initialized from specifiedBatchFlowInputUpdateGrouping
.FlatBatchUpdateFlowBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlatBatchUpdateFlowBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateFlow> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateFlow>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlatBatchUpdateFlow
build()
A newFlatBatchUpdateFlow
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
Return current value associated with the property corresponding toBatchOrderGrouping.getBatchOrder()
.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()
.FlatBatchUpdateFlowKey
key()
Return current value associated with the property corresponding toFlatBatchUpdateFlow.key()
.FlatBatchUpdateFlowBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateFlow>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchUpdateFlowBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBatchOrderGrouping.getBatchOrder()
to the specified value.FlatBatchUpdateFlowBuilder
setFlowId(FlowId value)
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.FlatBatchUpdateFlowBuilder
setOriginalBatchedFlow(OriginalBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getOriginalBatchedFlow()
to the specified value.FlatBatchUpdateFlowBuilder
setUpdatedBatchedFlow(UpdatedBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getUpdatedBatchedFlow()
to the specified value.FlatBatchUpdateFlowBuilder
withKey(FlatBatchUpdateFlowKey key)
-
-
-
Constructor Detail
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder()
Construct an empty builder.
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.- Parameters:
arg
- BatchOrderGrouping from which the builder should be initialized
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(BatchFlowInputUpdateGrouping arg)
Construct a new builder initialized from specifiedBatchFlowInputUpdateGrouping
.- Parameters:
arg
- BatchFlowInputUpdateGrouping from which the builder should be initialized
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(BatchFlowIdGrouping arg)
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.- Parameters:
arg
- BatchFlowIdGrouping from which the builder should be initialized
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(FlatBatchUpdateFlow base)
Construct a builder initialized with state from specifiedFlatBatchUpdateFlow
.- Parameters:
base
- FlatBatchUpdateFlow 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 FlatBatchUpdateFlowKey key()
Return current value associated with the property corresponding toFlatBatchUpdateFlow.key()
.- Returns:
- current value
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
Return current value associated with the property corresponding toBatchOrderGrouping.getBatchOrder()
.- 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<FlatBatchUpdateFlow>> 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 FlatBatchUpdateFlowBuilder withKey(FlatBatchUpdateFlowKey key)
-
setBatchOrder
public FlatBatchUpdateFlowBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBatchOrderGrouping.getBatchOrder()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setFlowId
public FlatBatchUpdateFlowBuilder setFlowId(FlowId value)
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOriginalBatchedFlow
public FlatBatchUpdateFlowBuilder setOriginalBatchedFlow(OriginalBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getOriginalBatchedFlow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUpdatedBatchedFlow
public FlatBatchUpdateFlowBuilder setUpdatedBatchedFlow(UpdatedBatchedFlow value)
Set the property corresponding toBatchFlowInputUpdateGrouping.getUpdatedBatchedFlow()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlatBatchUpdateFlowBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateFlow> 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 FlatBatchUpdateFlowBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateFlow>> 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 FlatBatchUpdateFlow build()
A newFlatBatchUpdateFlow
instance.- Returns:
- A new
FlatBatchUpdateFlow
instance.
-
-