org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.monitoring.response.monitoring.metrics.list.specific.metrics.list

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>

public class SpecificMetricsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SpecificMetrics>

Class that builds SpecificMetricsBuilder 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:

   
     SpecificMetricsBuilder createTarget(int fooXyzzy, int barBaz) {
         return new SpecificMetricsBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of SpecificMetricsBuilder, 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 oportunities, 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:

SpecificMetricsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SpecificMetricsBuilder()
SpecificMetricsBuilder(MonitoringMetrics arg)
SpecificMetricsBuilder(RpObject arg)
SpecificMetricsBuilder(SpecificMetrics base)

Method Summary

Modifier and Type	Method and Description
SpecificMetricsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics> augmentationValue)
<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)
SpecificMetricsBuilder	setMetricPce(List<MetricPce> values)
SpecificMetricsBuilder	setRp(Rp value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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:

• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.MonitoringMetrics
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.RpObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getMetricPce

public List<MetricPce> getMetricPce()

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(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> augmentationType,
                                              org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics> augmentationValue)

removeAugmentation

public SpecificMetricsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SpecificMetrics>> augmentationType)

build

public SpecificMetrics build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<SpecificMetrics,IllegalArgumentException>