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