Class VpnIpv4RoutesCaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv4.rev180329.bgp.rib.rib.peer.adj.rib.out.tables.routes.VpnIpv4RoutesCaseBuilder
Class that builds
VpnIpv4RoutesCase
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:
VpnIpv4RoutesCase createVpnIpv4RoutesCase(int fooXyzzy, int barBaz) {
return new VpnIpv4RoutesCaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of VpnIpv4RoutesCase, 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 specifiedVpnIpv4RoutesCase
.Construct a new builder initialized from specifiedL3vpnIpv4Routes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4RoutesCase> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4RoutesCase>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull VpnIpv4RoutesCase
build()
A newVpnIpv4RoutesCase
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toL3vpnIpv4Routes.getVpnIpv4Routes()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4RoutesCase>> augmentationType) Remove an augmentation from this builder's product.setVpnIpv4Routes
(VpnIpv4Routes value) Set the property corresponding toL3vpnIpv4Routes.getVpnIpv4Routes()
to the specified value.
-
Constructor Details
-
VpnIpv4RoutesCaseBuilder
public VpnIpv4RoutesCaseBuilder()Construct an empty builder. -
VpnIpv4RoutesCaseBuilder
Construct a new builder initialized from specifiedL3vpnIpv4Routes
.- Parameters:
arg
- L3vpnIpv4Routes from which the builder should be initialized
-
VpnIpv4RoutesCaseBuilder
Construct a builder initialized with state from specifiedVpnIpv4RoutesCase
.- Parameters:
base
- VpnIpv4RoutesCase 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
-
getVpnIpv4Routes
Return current value associated with the property corresponding toL3vpnIpv4Routes.getVpnIpv4Routes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4RoutesCase>> 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
-
setVpnIpv4Routes
Set the property corresponding toL3vpnIpv4Routes.getVpnIpv4Routes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public VpnIpv4RoutesCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4RoutesCase> 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 VpnIpv4RoutesCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4RoutesCase>> 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 newVpnIpv4RoutesCase
instance.- Returns:
- A new
VpnIpv4RoutesCase
instance.
-