Class VpnIpv4RoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv4.rev180329.l3vpn.ipv4.routes.VpnIpv4RoutesBuilder
-
@Generated("mdsal-binding-generator") public class VpnIpv4RoutesBuilder extends Object
Class that buildsVpnIpv4Routes
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:
VpnIpv4Routes createVpnIpv4Routes(int fooXyzzy, int barBaz) { return new VpnIpv4RoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnIpv4Routes, 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:
VpnIpv4Routes
- 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 VpnIpv4RoutesBuilder()
Construct an empty builder.VpnIpv4RoutesBuilder(VpnIpv4Routes base)
Construct a builder initialized with state from specifiedVpnIpv4Routes
.VpnIpv4RoutesBuilder(L3vpnIpRoute arg)
Construct a new builder initialized from specifiedL3vpnIpRoute
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnIpv4RoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Routes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Routes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull VpnIpv4Routes
build()
A newVpnIpv4Routes
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<VpnRouteKey,VpnRoute>
getVpnRoute()
Return current value associated with the property corresponding toL3vpnIpRoute.getVpnRoute()
.VpnIpv4RoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Routes>> augmentationType)
Remove an augmentation from this builder's product.VpnIpv4RoutesBuilder
setVpnRoute(Map<VpnRouteKey,VpnRoute> values)
Set the property corresponding toL3vpnIpRoute.getVpnRoute()
to the specified value.
-
-
-
Constructor Detail
-
VpnIpv4RoutesBuilder
public VpnIpv4RoutesBuilder()
Construct an empty builder.
-
VpnIpv4RoutesBuilder
public VpnIpv4RoutesBuilder(L3vpnIpRoute arg)
Construct a new builder initialized from specifiedL3vpnIpRoute
.- Parameters:
arg
- L3vpnIpRoute from which the builder should be initialized
-
VpnIpv4RoutesBuilder
public VpnIpv4RoutesBuilder(VpnIpv4Routes base)
Construct a builder initialized with state from specifiedVpnIpv4Routes
.- Parameters:
base
- VpnIpv4Routes from which the builder should be initialized
-
-
Method Detail
-
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
-
getVpnRoute
public Map<VpnRouteKey,VpnRoute> getVpnRoute()
Return current value associated with the property corresponding toL3vpnIpRoute.getVpnRoute()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Routes>> 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
-
setVpnRoute
public VpnIpv4RoutesBuilder setVpnRoute(Map<VpnRouteKey,VpnRoute> values)
Set the property corresponding toL3vpnIpRoute.getVpnRoute()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public VpnIpv4RoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Routes> 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 VpnIpv4RoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Routes>> 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 VpnIpv4Routes build()
A newVpnIpv4Routes
instance.- Returns:
- A new
VpnIpv4Routes
instance.
-
-