Class ReplyTimeBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.reply.time.grouping.ReplyTimeBuilder
Class that builds
ReplyTime
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:
ReplyTime createReplyTime(int fooXyzzy, int barBaz) {
return new ReplyTimeBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ReplyTime, 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
ConstructorsConstructorDescriptionConstruct an empty builder.ReplyTimeBuilder
(ReplyTime base) Construct a builder initialized with state from specifiedReplyTime
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<ReplyTime> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<ReplyTime>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ReplyTime
build()
A newReplyTime
instance.static @NonNull ReplyTime
empty()
Get empty instance of ReplyTime.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toReplyTime.getAverageTime()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toReplyTime.getMaxTime()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toReplyTime.getMinTime()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<ReplyTime>> augmentationType) Remove an augmentation from this builder's product.setAverageTime
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toReplyTime.getAverageTime()
to the specified value.setMaxTime
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toReplyTime.getMaxTime()
to the specified value.setMinTime
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toReplyTime.getMinTime()
to the specified value.
-
Constructor Details
-
ReplyTimeBuilder
public ReplyTimeBuilder()Construct an empty builder. -
ReplyTimeBuilder
Construct a builder initialized with state from specifiedReplyTime
.- Parameters:
base
- ReplyTime from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of ReplyTime.- Returns:
- An empty
ReplyTime
-
getAverageTime
public org.opendaylight.yangtools.yang.common.Uint32 getAverageTime()Return current value associated with the property corresponding toReplyTime.getAverageTime()
.- Returns:
- current value
-
getMaxTime
public org.opendaylight.yangtools.yang.common.Uint32 getMaxTime()Return current value associated with the property corresponding toReplyTime.getMaxTime()
.- Returns:
- current value
-
getMinTime
public org.opendaylight.yangtools.yang.common.Uint32 getMinTime()Return current value associated with the property corresponding toReplyTime.getMinTime()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<ReplyTime>> 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
-
setAverageTime
Set the property corresponding toReplyTime.getAverageTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxTime
Set the property corresponding toReplyTime.getMaxTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMinTime
Set the property corresponding toReplyTime.getMinTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ReplyTimeBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<ReplyTime> 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 ReplyTimeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<ReplyTime>> 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 newReplyTime
instance.- Returns:
- A new
ReplyTime
instance.
-