Class BgpLinkstateTopologyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.types.rev160524.bgp.linkstate.topology.type.BgpLinkstateTopologyBuilder
-
@Generated("mdsal-binding-generator") public class BgpLinkstateTopologyBuilder extends Object
Class that buildsBgpLinkstateTopology
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:
BgpLinkstateTopology createBgpLinkstateTopology(int fooXyzzy, int barBaz) { return new BgpLinkstateTopologyBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of BgpLinkstateTopology, 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:
BgpLinkstateTopology
- 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 BgpLinkstateTopologyBuilder()
Construct an empty builder.BgpLinkstateTopologyBuilder(BgpLinkstateTopology base)
Construct a builder initialized with state from specifiedBgpLinkstateTopology
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BgpLinkstateTopologyBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpLinkstateTopology> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpLinkstateTopology>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull BgpLinkstateTopology
build()
A newBgpLinkstateTopology
instance.BgpLinkstateTopologyBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpLinkstateTopology>> augmentationType)
Remove an augmentation from this builder's product.
-
-
-
Constructor Detail
-
BgpLinkstateTopologyBuilder
public BgpLinkstateTopologyBuilder()
Construct an empty builder.
-
BgpLinkstateTopologyBuilder
public BgpLinkstateTopologyBuilder(BgpLinkstateTopology base)
Construct a builder initialized with state from specifiedBgpLinkstateTopology
.- Parameters:
base
- BgpLinkstateTopology from which the builder should be initialized
-
-
Method Detail
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpLinkstateTopology>> 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
-
addAugmentation
public BgpLinkstateTopologyBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpLinkstateTopology> 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 BgpLinkstateTopologyBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpLinkstateTopology>> 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 @NonNull BgpLinkstateTopology build()
A newBgpLinkstateTopology
instance.- Returns:
- A new
BgpLinkstateTopology
instance.
-
-