Class L3vpnMcastDestinationBuilder
java.lang.Object
org.opendaylight.yangtools.binding.lib.AugmentableBuilder<L3vpnMcastDestination,L3vpnMcastDestinationBuilder>
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.L3vpnMcastDestinationBuilder
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Mutable
@Generated("mdsal-binding-generator")
public class L3vpnMcastDestinationBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<L3vpnMcastDestination,L3vpnMcastDestinationBuilder>
Class that builds
L3vpnMcastDestination 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:
L3vpnMcastDestination createL3vpnMcastDestination(int fooXyzzy, int barBaz) {
return new L3vpnMcastDestinationBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of L3vpnMcastDestination, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedL3vpnMcastDestination.Construct a new builder initialized from specifiedL3vpnMcastRoute.Construct a new builder initialized from specifiedPathIdGrouping.Construct a new builder initialized from specifiedRouteDistinguisherGrouping. -
Method Summary
Modifier and TypeMethodDescription@NonNull L3vpnMcastDestinationbuild()Returns A newL3vpnMcastDestinationinstance.voidfieldsFrom(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseorg.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefixDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseDeprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseSet the property corresponding toPathIdGrouping.getPathId()to the specified value.setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toL3vpnMcastRoute.getPrefix()to the specified value.Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()to the specified value.Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder
addAugmentation, augmentation, augmentations, removeAugmentation
-
Constructor Details
-
L3vpnMcastDestinationBuilder
public L3vpnMcastDestinationBuilder()Construct an empty builder. -
L3vpnMcastDestinationBuilder
Construct a new builder initialized from specifiedL3vpnMcastRoute.- Parameters:
arg- L3vpnMcastRoute from which the builder should be initialized
-
L3vpnMcastDestinationBuilder
Construct a new builder initialized from specifiedRouteDistinguisherGrouping.- Parameters:
arg- RouteDistinguisherGrouping from which the builder should be initialized
-
L3vpnMcastDestinationBuilder
Construct a new builder initialized from specifiedPathIdGrouping.- Parameters:
arg- PathIdGrouping from which the builder should be initialized
-
L3vpnMcastDestinationBuilder
Construct a builder initialized with state from specifiedL3vpnMcastDestination.- Parameters:
base- L3vpnMcastDestination from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
getPathId
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toPathIdGrouping.getPathId().- Returns:
- current value
-
getPrefix
@Deprecated(forRemoval=true) public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toL3vpnMcastRoute.getPrefix().- Returns:
- current value
-
getRouteDistinguisher
Deprecated, for removal: This API element is subject to removal in a future version.This method will not be generated in a future releaseReturn current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher().- Returns:
- current value
-
setPathId
Set the property corresponding toPathIdGrouping.getPathId()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPrefix
public L3vpnMcastDestinationBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toL3vpnMcastRoute.getPrefix()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setRouteDistinguisher
Set the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
Returns A newL3vpnMcastDestinationinstance.- Returns:
- A new
L3vpnMcastDestinationinstance
-