Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.types.rev160524
Class TopologyTypes1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.topology.types.rev160524.TopologyTypes1Builder
Class that builds
TopologyTypes1
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:
TopologyTypes1 createTopologyTypes1(int fooXyzzy, int barBaz) {
return new TopologyTypes1Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of TopologyTypes1, 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 new builder initialized from specifiedBgpIpv4ReachabilityTopologyType
.Construct a new builder initialized from specifiedBgpIpv6ReachabilityTopologyType
.Construct a new builder initialized from specifiedBgpLinkstateTopologyType
.Construct a builder initialized with state from specifiedTopologyTypes1
. -
Method Summary
Modifier and TypeMethodDescription@NonNull TopologyTypes1
build()
A newTopologyTypes1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toBgpIpv4ReachabilityTopologyType.getBgpIpv4ReachabilityTopology()
.Return current value associated with the property corresponding toBgpIpv6ReachabilityTopologyType.getBgpIpv6ReachabilityTopology()
.Return current value associated with the property corresponding toBgpLinkstateTopologyType.getBgpLinkstateTopology()
.Set the property corresponding toBgpIpv4ReachabilityTopologyType.getBgpIpv4ReachabilityTopology()
to the specified value.Set the property corresponding toBgpIpv6ReachabilityTopologyType.getBgpIpv6ReachabilityTopology()
to the specified value.Set the property corresponding toBgpLinkstateTopologyType.getBgpLinkstateTopology()
to the specified value.
-
Constructor Details
-
TopologyTypes1Builder
public TopologyTypes1Builder()Construct an empty builder. -
TopologyTypes1Builder
Construct a new builder initialized from specifiedBgpIpv4ReachabilityTopologyType
.- Parameters:
arg
- BgpIpv4ReachabilityTopologyType from which the builder should be initialized
-
TopologyTypes1Builder
Construct a new builder initialized from specifiedBgpIpv6ReachabilityTopologyType
.- Parameters:
arg
- BgpIpv6ReachabilityTopologyType from which the builder should be initialized
-
TopologyTypes1Builder
Construct a new builder initialized from specifiedBgpLinkstateTopologyType
.- Parameters:
arg
- BgpLinkstateTopologyType from which the builder should be initialized
-
TopologyTypes1Builder
Construct a builder initialized with state from specifiedTopologyTypes1
.- Parameters:
base
- TopologyTypes1 from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getBgpIpv4ReachabilityTopology
Return current value associated with the property corresponding toBgpIpv4ReachabilityTopologyType.getBgpIpv4ReachabilityTopology()
.- Returns:
- current value
-
getBgpIpv6ReachabilityTopology
Return current value associated with the property corresponding toBgpIpv6ReachabilityTopologyType.getBgpIpv6ReachabilityTopology()
.- Returns:
- current value
-
getBgpLinkstateTopology
Return current value associated with the property corresponding toBgpLinkstateTopologyType.getBgpLinkstateTopology()
.- Returns:
- current value
-
setBgpIpv4ReachabilityTopology
Set the property corresponding toBgpIpv4ReachabilityTopologyType.getBgpIpv4ReachabilityTopology()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBgpIpv6ReachabilityTopology
Set the property corresponding toBgpIpv6ReachabilityTopologyType.getBgpIpv6ReachabilityTopology()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setBgpLinkstateTopology
Set the property corresponding toBgpLinkstateTopologyType.getBgpLinkstateTopology()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newTopologyTypes1
instance.- Returns:
- A new
TopologyTypes1
instance.
-