Class BatchFailedFlowsOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flows.service.rev160314.batch.flow.output.list.grouping.BatchFailedFlowsOutputBuilder
-
@Generated("mdsal-binding-generator") public class BatchFailedFlowsOutputBuilder extends Object
Class that buildsBatchFailedFlowsOutput
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:
BatchFailedFlowsOutput createBatchFailedFlowsOutput(int fooXyzzy, int barBaz) { return new BatchFailedFlowsOutputBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchFailedFlowsOutput, 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:
BatchFailedFlowsOutput
- 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 BatchFailedFlowsOutputBuilder()
Construct an empty builder.BatchFailedFlowsOutputBuilder(BatchFailedFlowsOutput base)
Construct a builder initialized with state from specifiedBatchFailedFlowsOutput
.BatchFailedFlowsOutputBuilder(BatchFlowIdGrouping arg)
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.BatchFailedFlowsOutputBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchFailedFlowsOutputBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BatchFailedFlowsOutput
build()
A newBatchFailedFlowsOutput
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()
.BatchFailedFlowsOutputKey
key()
Return current value associated with the property corresponding toBatchFailedFlowsOutput.key()
.BatchFailedFlowsOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> augmentationType)
Remove an augmentation from this builder's product.BatchFailedFlowsOutputBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBatchOrderGrouping.getBatchOrder()
to the specified value.BatchFailedFlowsOutputBuilder
setFlowId(FlowId value)
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.BatchFailedFlowsOutputBuilder
withKey(BatchFailedFlowsOutputKey key)
-
-
-
Constructor Detail
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder()
Construct an empty builder.
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.- Parameters:
arg
- BatchOrderGrouping from which the builder should be initialized
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder(BatchFlowIdGrouping arg)
Construct a new builder initialized from specifiedBatchFlowIdGrouping
.- Parameters:
arg
- BatchFlowIdGrouping from which the builder should be initialized
-
BatchFailedFlowsOutputBuilder
public BatchFailedFlowsOutputBuilder(BatchFailedFlowsOutput base)
Construct a builder initialized with state from specifiedBatchFailedFlowsOutput
.- Parameters:
base
- BatchFailedFlowsOutput 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 BatchFailedFlowsOutputKey key()
Return current value associated with the property corresponding toBatchFailedFlowsOutput.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
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> 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 BatchFailedFlowsOutputBuilder withKey(BatchFailedFlowsOutputKey key)
-
setBatchOrder
public BatchFailedFlowsOutputBuilder 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 BatchFailedFlowsOutputBuilder setFlowId(FlowId value)
Set the property corresponding toBatchFlowIdGrouping.getFlowId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public BatchFailedFlowsOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput> 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 BatchFailedFlowsOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedFlowsOutput>> 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 BatchFailedFlowsOutput build()
A newBatchFailedFlowsOutput
instance.- Returns:
- A new
BatchFailedFlowsOutput
instance.
-
-