Package 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>
@Generated("mdsal-binding-generator") public class MetricObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MetricObject>
Class that buildsMetricObject
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:
MetricObject createMetricObject(int fooXyzzy, int barBaz) { return new MetricObjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MetricObject, 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:
MetricObject
,Builder
-
-
Constructor Summary
Constructors Constructor Description MetricObjectBuilder()
MetricObjectBuilder(MetricObject base)
MetricObjectBuilder(RsvpTeObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MetricObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject> augmentation)
Add an augmentation to this builder's product.<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.Boolean
getBound()
Boolean
getComputed()
org.opendaylight.yangtools.yang.common.Uint8
getMetricType()
Float32
getValue()
MetricObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> augmentationType)
Remove an augmentation from this builder's product.MetricObjectBuilder
setBound(Boolean value)
MetricObjectBuilder
setComputed(Boolean value)
MetricObjectBuilder
setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
MetricObjectBuilder
setValue(Float32 value)
-
-
-
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:- RsvpTeObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBound
public Boolean getBound()
-
getComputed
public Boolean getComputed()
-
getMetricType
public org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
-
getValue
public Float32 getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setBound
public MetricObjectBuilder setBound(Boolean value)
-
setComputed
public MetricObjectBuilder setComputed(Boolean value)
-
setMetricType
public MetricObjectBuilder setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setValue
public MetricObjectBuilder setValue(Float32 value)
-
addAugmentation
public MetricObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject> 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 MetricObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> 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 MetricObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MetricObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MetricObject,IllegalArgumentException>
-
-