Class UpdateFlowsBatchInputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.UpdateFlowsBatchInputBuilder
-
@Generated("mdsal-binding-generator") public class UpdateFlowsBatchInputBuilder extends Object
Class that buildsUpdateFlowsBatchInput
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:
UpdateFlowsBatchInput createUpdateFlowsBatchInput(int fooXyzzy, int barBaz) { return new UpdateFlowsBatchInputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of UpdateFlowsBatchInput, 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:
UpdateFlowsBatchInput
- 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 UpdateFlowsBatchInputBuilder()
Construct an empty builder.UpdateFlowsBatchInputBuilder(UpdateFlowsBatchInput base)
Construct a builder initialized with state from specifiedUpdateFlowsBatchInput
.UpdateFlowsBatchInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.UpdateFlowsBatchInputBuilder(BarrierSuffix arg)
Construct a new builder initialized from specifiedBarrierSuffix
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UpdateFlowsBatchInputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull UpdateFlowsBatchInput
build()
A newUpdateFlowsBatchInput
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBarrierAfter()
Return current value associated with the property corresponding toBarrierSuffix.getBarrierAfter()
.Map<BatchUpdateFlowsKey,BatchUpdateFlows>
getBatchUpdateFlows()
Return current value associated with the property corresponding toUpdateFlowsBatchInput.getBatchUpdateFlows()
.NodeRef
getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.UpdateFlowsBatchInputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput>> augmentationType)
Remove an augmentation from this builder's product.UpdateFlowsBatchInputBuilder
setBarrierAfter(Boolean value)
Set the property corresponding toBarrierSuffix.getBarrierAfter()
to the specified value.UpdateFlowsBatchInputBuilder
setBatchUpdateFlows(Map<BatchUpdateFlowsKey,BatchUpdateFlows> values)
Set the property corresponding toUpdateFlowsBatchInput.getBatchUpdateFlows()
to the specified value.UpdateFlowsBatchInputBuilder
setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.
-
-
-
Constructor Detail
-
UpdateFlowsBatchInputBuilder
public UpdateFlowsBatchInputBuilder()
Construct an empty builder.
-
UpdateFlowsBatchInputBuilder
public UpdateFlowsBatchInputBuilder(NodeContextRef arg)
Construct a new builder initialized from specifiedNodeContextRef
.- Parameters:
arg
- NodeContextRef from which the builder should be initialized
-
UpdateFlowsBatchInputBuilder
public UpdateFlowsBatchInputBuilder(BarrierSuffix arg)
Construct a new builder initialized from specifiedBarrierSuffix
.- Parameters:
arg
- BarrierSuffix from which the builder should be initialized
-
UpdateFlowsBatchInputBuilder
public UpdateFlowsBatchInputBuilder(UpdateFlowsBatchInput base)
Construct a builder initialized with state from specifiedUpdateFlowsBatchInput
.- Parameters:
base
- UpdateFlowsBatchInput 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
-
getBarrierAfter
public Boolean getBarrierAfter()
Return current value associated with the property corresponding toBarrierSuffix.getBarrierAfter()
.- Returns:
- current value
-
getBatchUpdateFlows
public Map<BatchUpdateFlowsKey,BatchUpdateFlows> getBatchUpdateFlows()
Return current value associated with the property corresponding toUpdateFlowsBatchInput.getBatchUpdateFlows()
.- Returns:
- current value
-
getNode
public NodeRef getNode()
Return current value associated with the property corresponding toNodeContextRef.getNode()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput>> 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
-
setBarrierAfter
public UpdateFlowsBatchInputBuilder setBarrierAfter(Boolean value)
Set the property corresponding toBarrierSuffix.getBarrierAfter()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBatchUpdateFlows
public UpdateFlowsBatchInputBuilder setBatchUpdateFlows(Map<BatchUpdateFlowsKey,BatchUpdateFlows> values)
Set the property corresponding toUpdateFlowsBatchInput.getBatchUpdateFlows()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setNode
public UpdateFlowsBatchInputBuilder setNode(NodeRef value)
Set the property corresponding toNodeContextRef.getNode()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public UpdateFlowsBatchInputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput> 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 UpdateFlowsBatchInputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<UpdateFlowsBatchInput>> 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 UpdateFlowsBatchInput build()
A newUpdateFlowsBatchInput
instance.- Returns:
- A new
UpdateFlowsBatchInput
instance.
-
-