Class SpecificMetricsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.specific.metrics.list.SpecificMetricsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SpecificMetrics>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SpecificMetrics,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SpecificMetricsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SpecificMetrics>
Class that buildsSpecificMetrics
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:
SpecificMetrics createSpecificMetrics(int fooXyzzy, int barBaz) { return new SpecificMetricsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SpecificMetrics, 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:
SpecificMetrics
,Builder
-
-
Constructor Summary
Constructors Constructor Description SpecificMetricsBuilder()
SpecificMetricsBuilder(SpecificMetrics base)
SpecificMetricsBuilder(MonitoringMetrics arg)
SpecificMetricsBuilder(RpObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpecificMetricsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>>
E$$augmentation(Class<E$$> augmentationType)
SpecificMetrics
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<MetricPce>
getMetricPce()
Rp
getRp()
SpecificMetricsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> augmentationType)
Remove an augmentation from this builder's product.SpecificMetricsBuilder
setMetricPce(List<MetricPce> values)
SpecificMetricsBuilder
setRp(Rp value)
-
-
-
Constructor Detail
-
SpecificMetricsBuilder
public SpecificMetricsBuilder()
-
SpecificMetricsBuilder
public SpecificMetricsBuilder(RpObject arg)
-
SpecificMetricsBuilder
public SpecificMetricsBuilder(MonitoringMetrics arg)
-
SpecificMetricsBuilder
public SpecificMetricsBuilder(SpecificMetrics base)
-
-
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:- MonitoringMetrics
- RpObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getRp
public Rp getRp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> E$$ augmentation(Class<E$$> augmentationType)
-
setMetricPce
public SpecificMetricsBuilder setMetricPce(List<MetricPce> values)
-
setRp
public SpecificMetricsBuilder setRp(Rp value)
-
addAugmentation
public SpecificMetricsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics> 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 SpecificMetricsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> 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 SpecificMetrics build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SpecificMetrics>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SpecificMetrics,IllegalArgumentException>
-
-