Class SpecificMetricsListBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.SpecificMetricsListBuilder
-
@Generated("mdsal-binding-generator") public class SpecificMetricsListBuilder extends Object
Class that buildsSpecificMetricsList
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:
SpecificMetricsList createSpecificMetricsList(int fooXyzzy, int barBaz) { return new SpecificMetricsListBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SpecificMetricsList, 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:
SpecificMetricsList
- 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
-
-
Constructor Summary
Constructors Constructor Description SpecificMetricsListBuilder()
Construct an empty builder.SpecificMetricsListBuilder(SpecificMetricsList base)
Construct a builder initialized with state from specifiedSpecificMetricsList
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpecificMetricsListBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetricsList> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetricsList>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SpecificMetricsList
build()
A newSpecificMetricsList
instance.List<SpecificMetrics>
getSpecificMetrics()
Return current value associated with the property corresponding toSpecificMetricsList.getSpecificMetrics()
.SpecificMetricsListBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetricsList>> augmentationType)
Remove an augmentation from this builder's product.SpecificMetricsListBuilder
setSpecificMetrics(List<SpecificMetrics> values)
Set the property corresponding toSpecificMetricsList.getSpecificMetrics()
to the specified value.
-
-
-
Constructor Detail
-
SpecificMetricsListBuilder
public SpecificMetricsListBuilder()
Construct an empty builder.
-
SpecificMetricsListBuilder
public SpecificMetricsListBuilder(SpecificMetricsList base)
Construct a builder initialized with state from specifiedSpecificMetricsList
.- Parameters:
base
- SpecificMetricsList from which the builder should be initialized
-
-
Method Detail
-
getSpecificMetrics
public List<SpecificMetrics> getSpecificMetrics()
Return current value associated with the property corresponding toSpecificMetricsList.getSpecificMetrics()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetricsList>> 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
-
setSpecificMetrics
public SpecificMetricsListBuilder setSpecificMetrics(List<SpecificMetrics> values)
Set the property corresponding toSpecificMetricsList.getSpecificMetrics()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public SpecificMetricsListBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetricsList> 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 SpecificMetricsListBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetricsList>> 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 @NonNull SpecificMetricsList build()
A newSpecificMetricsList
instance.- Returns:
- A new
SpecificMetricsList
instance.
-
-