Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.metric.object
Class MetricBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.metric.object.MetricBuilder
-
@Generated("mdsal-binding-generator") public class MetricBuilder extends Object
Class that buildsMetric
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:
Metric createMetric(int fooXyzzy, int barBaz) { return new MetricBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Metric, 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:
Metric
- 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 MetricBuilder()
Construct an empty builder.MetricBuilder(Metric base)
Construct a builder initialized with state from specifiedMetric
.MetricBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.MetricBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MetricBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Metric> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Metric
build()
A newMetric
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 toMetric.getBound()
.Boolean
getComputed()
Return current value associated with the property corresponding toMetric.getComputed()
.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.org.opendaylight.yangtools.yang.common.Uint8
getMetricType()
Return current value associated with the property corresponding toMetric.getMetricType()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.Float32
getValue()
Return current value associated with the property corresponding toMetric.getValue()
.MetricBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> augmentationType)
Remove an augmentation from this builder's product.MetricBuilder
setBound(Boolean value)
Set the property corresponding toMetric.getBound()
to the specified value.MetricBuilder
setComputed(Boolean value)
Set the property corresponding toMetric.getComputed()
to the specified value.MetricBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.MetricBuilder
setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMetric.getMetricType()
to the specified value.MetricBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.MetricBuilder
setValue(Float32 value)
Set the property corresponding toMetric.getValue()
to the specified value.
-
-
-
Constructor Detail
-
MetricBuilder
public MetricBuilder()
Construct an empty builder.
-
MetricBuilder
public MetricBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
MetricBuilder
public MetricBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader 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 toMetric.getBound()
.- Returns:
- current value
-
getComputed
public Boolean getComputed()
Return current value associated with the property corresponding toMetric.getComputed()
.- Returns:
- current value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getMetricType
public org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
Return current value associated with the property corresponding toMetric.getMetricType()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getValue
public Float32 getValue()
Return current value associated with the property corresponding toMetric.getValue()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> 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 MetricBuilder setBound(Boolean value)
Set the property corresponding toMetric.getBound()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setComputed
public MetricBuilder setComputed(Boolean value)
Set the property corresponding toMetric.getComputed()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
public MetricBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMetricType
public MetricBuilder setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toMetric.getMetricType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public MetricBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setValue
public MetricBuilder setValue(Float32 value)
Set the property corresponding toMetric.getValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MetricBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Metric> 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 MetricBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> 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
-
-