Class BatchFailedGroupsOutputBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.groups.service.rev160315.batch.group.output.list.grouping.BatchFailedGroupsOutputBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<BatchFailedGroupsOutput>
,org.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailedGroupsOutput,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class BatchFailedGroupsOutputBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<BatchFailedGroupsOutput>
Class that buildsBatchFailedGroupsOutputBuilder
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:
BatchFailedGroupsOutputBuilder createTarget(int fooXyzzy, int barBaz) { return new BatchFailedGroupsOutputBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BatchFailedGroupsOutputBuilder, 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:
BatchFailedGroupsOutputBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description BatchFailedGroupsOutputBuilder()
BatchFailedGroupsOutputBuilder(BatchFailedGroupsOutput base)
BatchFailedGroupsOutputBuilder(BatchOrderGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description BatchFailedGroupsOutputBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput>>
E$$augmentation(Class<E$$> augmentationType)
BatchFailedGroupsOutput
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint16
getBatchOrder()
GroupId
getGroupId()
BatchFailedGroupsOutputKey
key()
BatchFailedGroupsOutputBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput>> augmentationType)
BatchFailedGroupsOutputBuilder
setBatchOrder(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setBatchOrder(Uint16)} instead.BatchFailedGroupsOutputBuilder
setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
BatchFailedGroupsOutputBuilder
setGroupId(GroupId value)
BatchFailedGroupsOutputBuilder
withKey(BatchFailedGroupsOutputKey key)
-
-
-
Constructor Detail
-
BatchFailedGroupsOutputBuilder
public BatchFailedGroupsOutputBuilder()
-
BatchFailedGroupsOutputBuilder
public BatchFailedGroupsOutputBuilder(BatchOrderGrouping arg)
-
BatchFailedGroupsOutputBuilder
public BatchFailedGroupsOutputBuilder(BatchFailedGroupsOutput 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 BatchFailedGroupsOutputKey key()
-
getBatchOrder
public org.opendaylight.yangtools.yang.common.Uint16 getBatchOrder()
-
getGroupId
public GroupId getGroupId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public BatchFailedGroupsOutputBuilder withKey(BatchFailedGroupsOutputKey key)
-
setBatchOrder
public BatchFailedGroupsOutputBuilder setBatchOrder(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setBatchOrder
@Deprecated(forRemoval=true) public BatchFailedGroupsOutputBuilder 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
-
setGroupId
public BatchFailedGroupsOutputBuilder setGroupId(GroupId value)
-
addAugmentation
public BatchFailedGroupsOutputBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput> augmentationValue)
-
removeAugmentation
public BatchFailedGroupsOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BatchFailedGroupsOutput>> augmentationType)
-
build
public BatchFailedGroupsOutput build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<BatchFailedGroupsOutput>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<BatchFailedGroupsOutput,IllegalArgumentException>
-
-