Class IgpMetricBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.af.config.bestpath.bestpath.selection.IgpMetricBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IgpMetric>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IgpMetric,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class IgpMetricBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IgpMetric>
Class that buildsIgpMetricBuilder
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:
IgpMetricBuilder createTarget(int fooXyzzy, int barBaz) { return new IgpMetricBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IgpMetricBuilder, 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:
IgpMetricBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IgpMetricBuilder()
IgpMetricBuilder(IgpMetric base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IgpMetricBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IgpMetric
build()
java.lang.Boolean
isIgnoreIgpMetric()
IgpMetricBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric>> augmentationType)
IgpMetricBuilder
setIgnoreIgpMetric(java.lang.Boolean value)
-
-
-
Constructor Detail
-
IgpMetricBuilder
public IgpMetricBuilder()
-
IgpMetricBuilder
public IgpMetricBuilder(IgpMetric base)
-
-
Method Detail
-
isIgnoreIgpMetric
public java.lang.Boolean isIgnoreIgpMetric()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIgnoreIgpMetric
public IgpMetricBuilder setIgnoreIgpMetric(java.lang.Boolean value)
-
addAugmentation
public IgpMetricBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric> augmentationValue)
-
removeAugmentation
public IgpMetricBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IgpMetric>> augmentationType)
-
-