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
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchFailure>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailure,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchFailureBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchFailure>
Class that buildsBatchFailureBuilder
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:
BatchFailureBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchFailureBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchFailureBuilder, 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 oportunities, 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:
BatchFailureBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchFailureBuilder()
BatchFailureBuilder(BatchFailure base)
BatchFailureBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchFailureBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>>
E$$augmentation(Class<E$$> augmentationType)
BatchFailure
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.BatchItemIdChoice
getBatchItemIdChoice()
org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
BatchFailureKey
key()
BatchFailureBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> augmentationType)
BatchFailureBuilder
setBatchItemIdChoice(BatchItemIdChoice value)
BatchFailureBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.BatchFailureBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchFailureBuilder
withKey(BatchFailureKey key)
-
-
-
Constructor Detail
-
BatchFailureBuilder
public BatchFailureBuilder()
-
BatchFailureBuilder
public BatchFailureBuilder(BatchOrderGrouping arg)
-
BatchFailureBuilder
public BatchFailureBuilder(BatchFailure 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.service.batch.common.rev160322.BatchOrderGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public BatchFailureKey key()
-
getBatchItemIdChoice
public BatchItemIdChoice getBatchItemIdChoice()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchFailureBuilder withKey(BatchFailureKey key)
-
setBatchItemIdChoice
public BatchFailureBuilder setBatchItemIdChoice(BatchItemIdChoice value)
-
setBatchOrder
public BatchFailureBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public BatchFailureBuilder setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public BatchFailureBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure> augmentationValue)
-
removeAugmentation
public BatchFailureBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailure>> augmentationType)
-
build
public BatchFailure build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchFailure>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailure,IllegalArgumentException>
-
-