Class FlatBatchFailureGroupIdCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321.flat.batch.failure.ids.aug.FlatBatchFailureGroupIdCaseBuilder
-
@Generated("mdsal-binding-generator") public class FlatBatchFailureGroupIdCaseBuilder extends Object
Class that buildsFlatBatchFailureGroupIdCase
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:
FlatBatchFailureGroupIdCase createFlatBatchFailureGroupIdCase(int fooXyzzy, int barBaz) { return new FlatBatchFailureGroupIdCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of FlatBatchFailureGroupIdCase, 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:
FlatBatchFailureGroupIdCase
- 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 FlatBatchFailureGroupIdCaseBuilder()
Construct an empty builder.FlatBatchFailureGroupIdCaseBuilder(FlatBatchFailureGroupIdCase base)
Construct a builder initialized with state from specifiedFlatBatchFailureGroupIdCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FlatBatchFailureGroupIdCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureGroupIdCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureGroupIdCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull FlatBatchFailureGroupIdCase
build()
A newFlatBatchFailureGroupIdCase
instance.GroupId
getGroupId()
Return current value associated with the property corresponding toFlatBatchFailureGroupIdCase.getGroupId()
.FlatBatchFailureGroupIdCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureGroupIdCase>> augmentationType)
Remove an augmentation from this builder's product.FlatBatchFailureGroupIdCaseBuilder
setGroupId(GroupId value)
Set the property corresponding toFlatBatchFailureGroupIdCase.getGroupId()
to the specified value.
-
-
-
Constructor Detail
-
FlatBatchFailureGroupIdCaseBuilder
public FlatBatchFailureGroupIdCaseBuilder()
Construct an empty builder.
-
FlatBatchFailureGroupIdCaseBuilder
public FlatBatchFailureGroupIdCaseBuilder(FlatBatchFailureGroupIdCase base)
Construct a builder initialized with state from specifiedFlatBatchFailureGroupIdCase
.- Parameters:
base
- FlatBatchFailureGroupIdCase from which the builder should be initialized
-
-
Method Detail
-
getGroupId
public GroupId getGroupId()
Return current value associated with the property corresponding toFlatBatchFailureGroupIdCase.getGroupId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureGroupIdCase>> 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
-
setGroupId
public FlatBatchFailureGroupIdCaseBuilder setGroupId(GroupId value)
Set the property corresponding toFlatBatchFailureGroupIdCase.getGroupId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public FlatBatchFailureGroupIdCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureGroupIdCase> 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 FlatBatchFailureGroupIdCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<FlatBatchFailureGroupIdCase>> 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 FlatBatchFailureGroupIdCase build()
A newFlatBatchFailureGroupIdCase
instance.- Returns:
- A new
FlatBatchFailureGroupIdCase
instance.
-
-