Class L3UnicastIgpTopologyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.nt.l3.unicast.igp.topology.rev131021.l3.unicast.igp.topology.type.L3UnicastIgpTopologyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L3UnicastIgpTopology>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L3UnicastIgpTopology,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class L3UnicastIgpTopologyBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<L3UnicastIgpTopology>
Class that buildsL3UnicastIgpTopologyBuilder
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:
L3UnicastIgpTopologyBuilder createTarget(int fooXyzzy, int barBaz) { return new L3UnicastIgpTopologyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3UnicastIgpTopologyBuilder, 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:
L3UnicastIgpTopologyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L3UnicastIgpTopologyBuilder()
L3UnicastIgpTopologyBuilder(L3UnicastIgpTopology base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description L3UnicastIgpTopologyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3UnicastIgpTopology> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3UnicastIgpTopology>>
E$$augmentation(Class<E$$> augmentationType)
L3UnicastIgpTopology
build()
L3UnicastIgpTopologyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3UnicastIgpTopology>> augmentationType)
Remove an augmentation from this builder's product.
-
-
-
Constructor Detail
-
L3UnicastIgpTopologyBuilder
public L3UnicastIgpTopologyBuilder()
-
L3UnicastIgpTopologyBuilder
public L3UnicastIgpTopologyBuilder(L3UnicastIgpTopology base)
-
-
Method Detail
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3UnicastIgpTopology>> E$$ augmentation(Class<E$$> augmentationType)
-
addAugmentation
public L3UnicastIgpTopologyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3UnicastIgpTopology> 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 L3UnicastIgpTopologyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3UnicastIgpTopology>> 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 L3UnicastIgpTopology build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<L3UnicastIgpTopology>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<L3UnicastIgpTopology,IllegalArgumentException>
-
-