Class VpnIpv4DestinationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.vpn.ipv4.rev180329.l3vpn.ipv4.destination.VpnIpv4DestinationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VpnIpv4Destination>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VpnIpv4Destination,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class VpnIpv4DestinationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<VpnIpv4Destination>
Class that buildsVpnIpv4Destination
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:
VpnIpv4Destination createVpnIpv4Destination(int fooXyzzy, int barBaz) { return new VpnIpv4DestinationBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VpnIpv4Destination, 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:
VpnIpv4Destination
,Builder
-
-
Constructor Summary
Constructors Constructor Description VpnIpv4DestinationBuilder()
VpnIpv4DestinationBuilder(VpnIpv4Destination base)
VpnIpv4DestinationBuilder(L3vpnIpDestinationType arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description VpnIpv4DestinationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Destination> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Destination>>
E$$augmentation(Class<E$$> augmentationType)
VpnIpv4Destination
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<VpnDestination>
getVpnDestination()
VpnIpv4DestinationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Destination>> augmentationType)
Remove an augmentation from this builder's product.VpnIpv4DestinationBuilder
setVpnDestination(List<VpnDestination> values)
-
-
-
Constructor Detail
-
VpnIpv4DestinationBuilder
public VpnIpv4DestinationBuilder()
-
VpnIpv4DestinationBuilder
public VpnIpv4DestinationBuilder(L3vpnIpDestinationType arg)
-
VpnIpv4DestinationBuilder
public VpnIpv4DestinationBuilder(VpnIpv4Destination base)
-
-
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:- L3vpnIpDestinationType
- 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()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Destination>> E$$ augmentation(Class<E$$> augmentationType)
-
setVpnDestination
public VpnIpv4DestinationBuilder setVpnDestination(List<VpnDestination> values)
-
addAugmentation
public VpnIpv4DestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Destination> 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 VpnIpv4DestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VpnIpv4Destination>> 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 VpnIpv4Destination build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<VpnIpv4Destination>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<VpnIpv4Destination,IllegalArgumentException>
-
-