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