Class L3vpnMcastDestinationBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.destination.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
ConstructorDescriptionConstruct 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 TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastDestination> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastDestination>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull L3vpnMcastDestination
build()
A newL3vpnMcastDestination
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
Return current value associated with the property corresponding toL3vpnMcastRoute.getPrefix()
.Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastDestination>> augmentationType) Remove an augmentation from this builder's product.Set 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.
-
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.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
-
getPathId
Return current value associated with the property corresponding toPathIdGrouping.getPathId()
.- Returns:
- current value
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()Return current value associated with the property corresponding toL3vpnMcastRoute.getPrefix()
.- Returns:
- current value
-
getRouteDistinguisher
Return current value associated with the property corresponding toRouteDistinguisherGrouping.getRouteDistinguisher()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastDestination>> 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
-
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
-
addAugmentation
public L3vpnMcastDestinationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastDestination> 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 L3vpnMcastDestinationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastDestination>> 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 newL3vpnMcastDestination
instance.- Returns:
- A new
L3vpnMcastDestination
instance.
-