Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lsp.attributes
Class MetricsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.lsp.attributes.MetricsBuilder
-
@Generated("mdsal-binding-generator") public class MetricsBuilder extends Object
Class that buildsMetrics
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:
Metrics createMetrics(int fooXyzzy, int barBaz) { return new MetricsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Metrics, 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:
Metrics
- 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 MetricsBuilder()
Construct an empty builder.MetricsBuilder(Metrics base)
Construct a builder initialized with state from specifiedMetrics
.MetricsBuilder(MetricObject arg)
Construct a new builder initialized from specifiedMetricObject
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MetricsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Metrics> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Metrics
build()
A newMetrics
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Metric
getMetric()
Return current value associated with the property corresponding toMetricObject.getMetric()
.MetricsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> augmentationType)
Remove an augmentation from this builder's product.MetricsBuilder
setMetric(Metric value)
Set the property corresponding toMetricObject.getMetric()
to the specified value.
-
-
-
Constructor Detail
-
MetricsBuilder
public MetricsBuilder()
Construct an empty builder.
-
MetricsBuilder
public MetricsBuilder(MetricObject arg)
Construct a new builder initialized from specifiedMetricObject
.- Parameters:
arg
- MetricObject from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMetric
public Metric getMetric()
Return current value associated with the property corresponding toMetricObject.getMetric()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> 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
-
setMetric
public MetricsBuilder setMetric(Metric value)
Set the property corresponding toMetricObject.getMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MetricsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Metrics> 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 MetricsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> 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
-
-