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
-
@Generated("mdsal-binding-generator") public class MetricObjectBuilder extends Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description MetricObjectBuilder()
Construct an empty builder.MetricObjectBuilder(MetricObject base)
Construct a builder initialized with state from specifiedMetricObject
.MetricObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull MetricObject
build()
A newMetricObject
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getBound()
Return current value associated with the property corresponding toMetricObject.getBound()
.Boolean
getComputed()
Return current value associated with the property corresponding toMetricObject.getComputed()
.org.opendaylight.yangtools.yang.common.Uint8
getMetricType()
Return current value associated with the property corresponding toMetricObject.getMetricType()
.Float32
getValue()
Return current value associated with the property corresponding toMetricObject.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)
Set the property corresponding toMetricObject.getBound()
to the specified value.MetricObjectBuilder
setComputed(Boolean value)
Set the property corresponding toMetricObject.getComputed()
to the specified value.MetricObjectBuilder
setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMetricObject.getMetricType()
to the specified value.MetricObjectBuilder
setValue(Float32 value)
Set the property corresponding toMetricObject.getValue()
to the specified value.
-
-
-
Constructor Detail
-
MetricObjectBuilder
public MetricObjectBuilder()
Construct an empty builder.
-
MetricObjectBuilder
public MetricObjectBuilder(RsvpTeObject arg)
Construct a new builder initialized from specifiedRsvpTeObject
.- Parameters:
arg
- RsvpTeObject from which the builder should be initialized
-
MetricObjectBuilder
public MetricObjectBuilder(MetricObject base)
Construct a builder initialized with state from specifiedMetricObject
.- Parameters:
base
- MetricObject from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBound
public Boolean getBound()
Return current value associated with the property corresponding toMetricObject.getBound()
.- Returns:
- current value
-
getComputed
public Boolean getComputed()
Return current value associated with the property corresponding toMetricObject.getComputed()
.- Returns:
- current value
-
getMetricType
public org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
Return current value associated with the property corresponding toMetricObject.getMetricType()
.- Returns:
- current value
-
getValue
public Float32 getValue()
Return current value associated with the property corresponding toMetricObject.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetricObject>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setBound
public MetricObjectBuilder setBound(Boolean value)
Set the property corresponding toMetricObject.getBound()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setComputed
public MetricObjectBuilder setComputed(Boolean value)
Set the property corresponding toMetricObject.getComputed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetricType
public MetricObjectBuilder setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMetricObject.getMetricType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public MetricObjectBuilder setValue(Float32 value)
Set the property corresponding toMetricObject.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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 @NonNull MetricObject build()
A newMetricObject
instance.- Returns:
- A new
MetricObject
instance.
-
-