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