Class SnapshotGatheringStatusEndBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping.SnapshotGatheringStatusEndBuilder
Class that builds
SnapshotGatheringStatusEnd
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:
SnapshotGatheringStatusEnd createSnapshotGatheringStatusEnd(int fooXyzzy, int barBaz) {
return new SnapshotGatheringStatusEndBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SnapshotGatheringStatusEnd, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedSnapshotGatheringStatusEnd
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(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) Return the specified augmentation, if it is present in this builder.@NonNull SnapshotGatheringStatusEnd
build()
A newSnapshotGatheringStatusEnd
instance.static @NonNull SnapshotGatheringStatusEnd
empty()
Get empty instance of SnapshotGatheringStatusEnd.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime
getEnd()
Return current value associated with the property corresponding toSnapshotGatheringStatusEnd.getEnd()
.Return current value associated with the property corresponding toSnapshotGatheringStatusEnd.getSucceeded()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd>> augmentationType) Remove an augmentation from this builder's product.setEnd
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value) Set the property corresponding toSnapshotGatheringStatusEnd.getEnd()
to the specified value.setSucceeded
(Boolean value) Set the property corresponding toSnapshotGatheringStatusEnd.getSucceeded()
to the specified value.
-
Constructor Details
-
SnapshotGatheringStatusEndBuilder
public SnapshotGatheringStatusEndBuilder()Construct an empty builder. -
SnapshotGatheringStatusEndBuilder
Construct a builder initialized with state from specifiedSnapshotGatheringStatusEnd
.- Parameters:
base
- SnapshotGatheringStatusEnd from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of SnapshotGatheringStatusEnd.- Returns:
- An empty
SnapshotGatheringStatusEnd
-
getEnd
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getEnd()Return current value associated with the property corresponding toSnapshotGatheringStatusEnd.getEnd()
.- Returns:
- current value
-
getSucceeded
Return current value associated with the property corresponding toSnapshotGatheringStatusEnd.getSucceeded()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusEnd>> 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
-
setEnd
public SnapshotGatheringStatusEndBuilder setEnd(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value) Set the property corresponding toSnapshotGatheringStatusEnd.getEnd()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSucceeded
Set the property corresponding toSnapshotGatheringStatusEnd.getSucceeded()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
A newSnapshotGatheringStatusEnd
instance.- Returns:
- A new
SnapshotGatheringStatusEnd
instance.
-