Class SnapshotGatheringStatusEndBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping.SnapshotGatheringStatusEndBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SnapshotGatheringStatusEnd>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SnapshotGatheringStatusEnd,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SnapshotGatheringStatusEndBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SnapshotGatheringStatusEnd>
Class that buildsSnapshotGatheringStatusEndBuilder
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:
SnapshotGatheringStatusEndBuilder createTarget(int fooXyzzy, int barBaz) { return new SnapshotGatheringStatusEndBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SnapshotGatheringStatusEndBuilder, 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:
SnapshotGatheringStatusEndBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SnapshotGatheringStatusEndBuilder()
SnapshotGatheringStatusEndBuilder(SnapshotGatheringStatusEnd base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SnapshotGatheringStatusEndBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd>>
E$$augmentation(Class<E$$> augmentationType)
SnapshotGatheringStatusEnd
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime
getEnd()
Boolean
getSucceeded()
Boolean
isSucceeded()
Deprecated, for removal: This API element is subject to removal in a future version.SnapshotGatheringStatusEndBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd>> augmentationType)
Remove an augmentation from this builder's product.SnapshotGatheringStatusEndBuilder
setEnd(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value)
SnapshotGatheringStatusEndBuilder
setSucceeded(Boolean value)
-
-
-
Constructor Detail
-
SnapshotGatheringStatusEndBuilder
public SnapshotGatheringStatusEndBuilder()
-
SnapshotGatheringStatusEndBuilder
public SnapshotGatheringStatusEndBuilder(SnapshotGatheringStatusEnd base)
-
-
Method Detail
-
getEnd
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getEnd()
-
getSucceeded
public Boolean getSucceeded()
-
isSucceeded
@Deprecated(forRemoval=true) public final Boolean isSucceeded()
Deprecated, for removal: This API element is subject to removal in a future version.
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd>> E$$ augmentation(Class<E$$> augmentationType)
-
setEnd
public SnapshotGatheringStatusEndBuilder setEnd(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value)
-
setSucceeded
public SnapshotGatheringStatusEndBuilder setSucceeded(Boolean value)
-
addAugmentation
public SnapshotGatheringStatusEndBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd> 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 SnapshotGatheringStatusEndBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd>> 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 SnapshotGatheringStatusEnd build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SnapshotGatheringStatusEnd>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SnapshotGatheringStatusEnd,IllegalArgumentException>
-
-