Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.output
Class BatchFailureBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.process.flat.batch.output.BatchFailureBuilder
-
@Generated("mdsal-binding-generator") public class BatchFailureBuilder extends Object
Class that buildsBatchFailure
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:
BatchFailure createBatchFailure(int fooXyzzy, int barBaz) { return new BatchFailureBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchFailure, 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:
BatchFailure
- 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 BatchFailureBuilder()
Construct an empty builder.BatchFailureBuilder(BatchFailure base)
Construct a builder initialized with state from specifiedBatchFailure
.BatchFailureBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BatchFailureBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BatchFailure
build()
A newBatchFailure
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BatchItemIdChoice
getBatchItemIdChoice()
Return current value associated with the property corresponding toBatchFailure.getBatchItemIdChoice()
.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
Return current value associated with the property corresponding toBatchOrderGrouping.getBatchOrder()
.BatchFailureKey
key()
Return current value associated with the property corresponding toBatchFailure.key()
.BatchFailureBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> augmentationType)
Remove an augmentation from this builder's product.BatchFailureBuilder
setBatchItemIdChoice(BatchItemIdChoice value)
Set the property corresponding toBatchFailure.getBatchItemIdChoice()
to the specified value.BatchFailureBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toBatchOrderGrouping.getBatchOrder()
to the specified value.BatchFailureBuilder
withKey(BatchFailureKey key)
-
-
-
Constructor Detail
-
BatchFailureBuilder
public BatchFailureBuilder()
Construct an empty builder.
-
BatchFailureBuilder
public BatchFailureBuilder(BatchOrderGrouping arg)
Construct a new builder initialized from specifiedBatchOrderGrouping
.- Parameters:
arg
- BatchOrderGrouping from which the builder should be initialized
-
BatchFailureBuilder
public BatchFailureBuilder(BatchFailure base)
Construct a builder initialized with state from specifiedBatchFailure
.- Parameters:
base
- BatchFailure 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 BatchFailureKey key()
Return current value associated with the property corresponding toBatchFailure.key()
.- Returns:
- current value
-
getBatchItemIdChoice
public BatchItemIdChoice getBatchItemIdChoice()
Return current value associated with the property corresponding toBatchFailure.getBatchItemIdChoice()
.- 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
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> 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 BatchFailureBuilder withKey(BatchFailureKey key)
-
setBatchItemIdChoice
public BatchFailureBuilder setBatchItemIdChoice(BatchItemIdChoice value)
Set the property corresponding toBatchFailure.getBatchItemIdChoice()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBatchOrder
public BatchFailureBuilder 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
-
addAugmentation
public BatchFailureBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure> 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 BatchFailureBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> 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 BatchFailure build()
A newBatchFailure
instance.- Returns:
- A new
BatchFailure
instance.
-
-