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

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<Metrics>, org.opendaylight.yangtools.concepts.CheckedBuilder<Metrics,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class MetricsBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Metrics>

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

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

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

MetricsBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
MetricsBuilder()
MetricsBuilder(MetricObject arg)
MetricsBuilder(Metrics base)

Method Summary

Modifier and Type	Method and Description
MetricsBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Metrics> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> E$$	augmentation(Class<E$$> augmentationType)
Metrics	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Metric	getMetric()
MetricsBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> augmentationType)
MetricsBuilder	setMetric(Metric value)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsBuilder

public MetricsBuilder()

MetricsBuilder

public MetricsBuilder(MetricObject arg)

MetricsBuilder

public MetricsBuilder(Metrics 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.MetricObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getMetric

public Metric getMetric()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> E$$ augmentation(Class<E$$> augmentationType)

setMetric

public MetricsBuilder setMetric(Metric value)

addAugmentation

public MetricsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metrics>> augmentationType,
                                      org.opendaylight.yangtools.yang.binding.Augmentation<Metrics> augmentationValue)

removeAugmentation

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

build

public Metrics build()

Specified by:

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