Class DurationBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.statistics.DurationBuilder
Class that builds
Duration
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:
Duration createDuration(int fooXyzzy, int barBaz) {
return new DurationBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Duration, 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.DurationBuilder
(Duration base) Construct a builder initialized with state from specifiedDuration
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Duration> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Duration>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Duration
build()
A newDuration
instance.static @NonNull Duration
empty()
Get empty instance of Duration.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
Return current value associated with the property corresponding toDuration.getNanosecond()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32
Return current value associated with the property corresponding toDuration.getSecond()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Duration>> augmentationType) Remove an augmentation from this builder's product.setNanosecond
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toDuration.getNanosecond()
to the specified value.setSecond
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toDuration.getSecond()
to the specified value.
-
Constructor Details
-
DurationBuilder
public DurationBuilder()Construct an empty builder. -
DurationBuilder
Construct a builder initialized with state from specifiedDuration
.- Parameters:
base
- Duration from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Duration.- Returns:
- An empty
Duration
-
getNanosecond
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getNanosecond()Return current value associated with the property corresponding toDuration.getNanosecond()
.- Returns:
- current value
-
getSecond
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 getSecond()Return current value associated with the property corresponding toDuration.getSecond()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Duration>> 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
-
setNanosecond
public DurationBuilder setNanosecond(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toDuration.getNanosecond()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSecond
public DurationBuilder setSecond(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Counter32 value) Set the property corresponding toDuration.getSecond()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DurationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Duration> 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 DurationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Duration>> 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 newDuration
instance.- Returns:
- A new
Duration
instance.
-