Class MetricBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.svec.MetricBuilder
Class that builds
Metric
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:
Metric createMetric(int fooXyzzy, int barBaz) {
return new MetricBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Metric, 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 new builder initialized from specifiedMetricObject
.MetricBuilder
(Metric base) Construct a builder initialized with state from specifiedMetric
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Metric> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Metric>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Metric
build()
A newMetric
instance.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMetricObject.getMetric()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Metric>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toMetricObject.getMetric()
to the specified value.
-
Constructor Details
-
MetricBuilder
public MetricBuilder()Construct an empty builder. -
MetricBuilder
Construct a new builder initialized from specifiedMetricObject
.- Parameters:
arg
- MetricObject from which the builder should be initialized
-
MetricBuilder
Construct a builder initialized with state from specifiedMetric
.- Parameters:
base
- Metric from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
Return current value associated with the property corresponding toMetricObject.getMetric()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Metric>> 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
Set the property corresponding toMetricObject.getMetric()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MetricBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Metric> 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 MetricBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Metric>> 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 newMetric
instance.- Returns:
- A new
Metric
instance.
-