org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.metric.object

Class MetricObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.metric.object.MetricObjectBuilder

All Implemented Interfaces:

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

public class MetricObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<MetricObject>

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

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

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

MetricObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
MetricObjectBuilder()
MetricObjectBuilder(MetricObject base)
MetricObjectBuilder(RsvpTeObject arg)

Method Summary

Modifier and Type	Method and Description
MetricObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> E$$	augmentation(Class<E$$> augmentationType)
MetricObject	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Short	getMetricType()
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32	getValue()
Boolean	isBound()
Boolean	isComputed()
MetricObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> augmentationType)
MetricObjectBuilder	setBound(Boolean value)
MetricObjectBuilder	setComputed(Boolean value)
MetricObjectBuilder	setMetricType(Short value)
MetricObjectBuilder	setValue(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricObjectBuilder

public MetricObjectBuilder()

MetricObjectBuilder

public MetricObjectBuilder(RsvpTeObject arg)

MetricObjectBuilder

public MetricObjectBuilder(MetricObject 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.rsvp.rev150820.RsvpTeObject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getMetricType

public Short getMetricType()

getValue

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 getValue()

isBound

public Boolean isBound()

isComputed

public Boolean isComputed()

augmentation

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

setMetricType

public MetricObjectBuilder setMetricType(Short value)

setValue

public MetricObjectBuilder setValue(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ieee754.rev130819.Float32 value)

setBound

public MetricObjectBuilder setBound(Boolean value)

setComputed

public MetricObjectBuilder setComputed(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public MetricObject build()

Specified by:

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