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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateFlow>
,org.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchUpdateFlow,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class FlatBatchUpdateFlowBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateFlow>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description FlatBatchUpdateFlowBuilder()
FlatBatchUpdateFlowBuilder(FlatBatchUpdateFlow base)
FlatBatchUpdateFlowBuilder(BatchFlowIdGrouping arg)
FlatBatchUpdateFlowBuilder(BatchFlowInputUpdateGrouping arg)
FlatBatchUpdateFlowBuilder(BatchOrderGrouping arg)
-
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)
FlatBatchUpdateFlow
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
FlowId
getFlowId()
OriginalBatchedFlow
getOriginalBatchedFlow()
UpdatedBatchedFlow
getUpdatedBatchedFlow()
FlatBatchUpdateFlowKey
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)
FlatBatchUpdateFlowBuilder
setFlowId(FlowId value)
FlatBatchUpdateFlowBuilder
setOriginalBatchedFlow(OriginalBatchedFlow value)
FlatBatchUpdateFlowBuilder
setUpdatedBatchedFlow(UpdatedBatchedFlow value)
FlatBatchUpdateFlowBuilder
withKey(FlatBatchUpdateFlowKey key)
-
-
-
Constructor Detail
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder()
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(BatchOrderGrouping arg)
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(BatchFlowInputUpdateGrouping arg)
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(BatchFlowIdGrouping arg)
-
FlatBatchUpdateFlowBuilder
public FlatBatchUpdateFlowBuilder(FlatBatchUpdateFlow 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:- BatchFlowIdGrouping
- BatchFlowInputUpdateGrouping
- BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
key
public FlatBatchUpdateFlowKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getFlowId
public FlowId getFlowId()
-
getOriginalBatchedFlow
public OriginalBatchedFlow getOriginalBatchedFlow()
-
getUpdatedBatchedFlow
public UpdatedBatchedFlow getUpdatedBatchedFlow()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchUpdateFlow>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public FlatBatchUpdateFlowBuilder withKey(FlatBatchUpdateFlowKey key)
-
setBatchOrder
public FlatBatchUpdateFlowBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setFlowId
public FlatBatchUpdateFlowBuilder setFlowId(FlowId value)
-
setOriginalBatchedFlow
public FlatBatchUpdateFlowBuilder setOriginalBatchedFlow(OriginalBatchedFlow value)
-
setUpdatedBatchedFlow
public FlatBatchUpdateFlowBuilder setUpdatedBatchedFlow(UpdatedBatchedFlow value)
-
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 FlatBatchUpdateFlow build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<FlatBatchUpdateFlow>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<FlatBatchUpdateFlow,IllegalArgumentException>
-
-