org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2mp

Class MetricBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.requests.segment.computation.p2mp.MetricBuilder

All Implemented Interfaces:

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

public class MetricBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Metric>

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

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

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

MetricBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
MetricBuilder()
MetricBuilder(Metric base)
MetricBuilder(MetricObject arg)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricBuilder

public MetricBuilder()

MetricBuilder

public MetricBuilder(MetricObject arg)

MetricBuilder

public MetricBuilder(Metric 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<Metric>> E$$ augmentation(Class<E$$> augmentationType)

setMetric

public MetricBuilder setMetric(Metric value)

addAugmentation

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

removeAugmentation

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

build

public Metric build()

Specified by:

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