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
-
- 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 buildsMetricBuilder
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 Description MetricBuilder()
MetricBuilder(Metric base)
MetricBuilder(Object arg)
MetricBuilder(ObjectHeader arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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.org.opendaylight.yangtools.yang.common.Uint8
getMetricType()
Float32
getValue()
Boolean
isBound()
Boolean
isComputed()
Boolean
isIgnore()
Boolean
isProcessingRule()
MetricBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> augmentationType)
MetricBuilder
setBound(Boolean value)
MetricBuilder
setComputed(Boolean value)
MetricBuilder
setIgnore(Boolean value)
MetricBuilder
setMetricType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMetricType(Uint8)} instead.MetricBuilder
setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
MetricBuilder
setProcessingRule(Boolean value)
MetricBuilder
setValue(Float32 value)
-
-
-
Constructor Detail
-
MetricBuilder
public MetricBuilder()
-
MetricBuilder
public MetricBuilder(Object arg)
-
MetricBuilder
public MetricBuilder(ObjectHeader 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.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getMetricType
public org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
-
getValue
public Float32 getValue()
-
isBound
public Boolean isBound()
-
isComputed
public Boolean isComputed()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> E$$ augmentation(Class<E$$> augmentationType)
-
setMetricType
public MetricBuilder setMetricType(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setMetricType
@Deprecated(forRemoval=true) public MetricBuilder setMetricType(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMetricType(Uint8)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setValue
public MetricBuilder setValue(Float32 value)
-
setBound
public MetricBuilder setBound(Boolean value)
-
setComputed
public MetricBuilder setComputed(Boolean value)
-
setIgnore
public MetricBuilder setIgnore(Boolean value)
-
setProcessingRule
public MetricBuilder setProcessingRule(Boolean 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 interfaceorg.opendaylight.yangtools.concepts.Builder<Metric>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Metric,IllegalArgumentException>
-
-