Class MetricBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcreq.message.pcreq.message.svec.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>
@Generated("mdsal-binding-generator") 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(MetricObject arg)
MetricBuilder(Metric base)
-
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)
Metric
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Metric
getMetric()
MetricBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> augmentationType)
Remove an augmentation from this builder's product.MetricBuilder
setMetric(Metric value)
-
-
-
Constructor Detail
-
MetricBuilder
public MetricBuilder()
-
MetricBuilder
public MetricBuilder(MetricObject 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.MetricObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMetric
public Metric getMetric()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metric>> E$$ augmentation(Class<E$$> augmentationType)
-
setMetric
public MetricBuilder setMetric(Metric value)
-
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
-
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>
-
-