Class L3vpnMcastRouteBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.L3vpnMcastRouteBuilder
Class that builds
L3vpnMcastRoute
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:
L3vpnMcastRoute createL3vpnMcastRoute(int fooXyzzy, int barBaz) {
return new L3vpnMcastRouteBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of L3vpnMcastRoute, 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 specifiedL3vpnMcastRoute
.Construct a new builder initialized from specifiedL3vpnMcastRoute
.Construct a new builder initialized from specifiedPathAttributes
.Construct a new builder initialized from specifiedPathIdGrouping
.Construct a new builder initialized from specifiedRoute
.Construct a new builder initialized from specifiedRouteDistinguisherGrouping
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull L3vpnMcastRoute
build()
A newL3vpnMcastRoute
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toPathAttributes.getAttributes()
.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()
.Return current value associated with the property corresponding toRoute.getRouteKey()
.key()
Return current value associated with the property corresponding toL3vpnMcastRoute.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> augmentationType) Remove an augmentation from this builder's product.setAttributes
(Attributes value) Set the property corresponding toPathAttributes.getAttributes()
to the specified value.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.setRouteKey
(String value) Set the property corresponding toRoute.getRouteKey()
to the specified value.Set the key value corresponding toL3vpnMcastRoute.key()
to the specified value.
-
Constructor Details
-
L3vpnMcastRouteBuilder
public L3vpnMcastRouteBuilder()Construct an empty builder. -
L3vpnMcastRouteBuilder
Construct a new builder initialized from specifiedRoute
.- Parameters:
arg
- Route from which the builder should be initialized
-
L3vpnMcastRouteBuilder
Construct a new builder initialized from specifiedPathIdGrouping
.- Parameters:
arg
- PathIdGrouping from which the builder should be initialized
-
L3vpnMcastRouteBuilder
Construct a new builder initialized from specifiedPathAttributes
.- Parameters:
arg
- PathAttributes from which the builder should be initialized
-
L3vpnMcastRouteBuilder
Construct a new builder initialized from specifiedL3vpnMcastRoute
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoute from which the builder should be initialized
-
L3vpnMcastRouteBuilder
Construct a new builder initialized from specifiedRouteDistinguisherGrouping
.- Parameters:
arg
- RouteDistinguisherGrouping from which the builder should be initialized
-
L3vpnMcastRouteBuilder
Construct a builder initialized with state from specifiedL3vpnMcastRoute
.- Parameters:
base
- L3vpnMcastRoute 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
-
key
Return current value associated with the property corresponding toL3vpnMcastRoute.key()
.- Returns:
- current value
-
getAttributes
Return current value associated with the property corresponding toPathAttributes.getAttributes()
.- Returns:
- current 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
-
getRouteKey
Return current value associated with the property corresponding toRoute.getRouteKey()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> 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
-
withKey
Set the key value corresponding toL3vpnMcastRoute.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setAttributes
Set the property corresponding toPathAttributes.getAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPathId
Set the property corresponding toPathIdGrouping.getPathId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrefix
public L3vpnMcastRouteBuilder 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
-
setRouteKey
Set the property corresponding toRoute.getRouteKey()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public L3vpnMcastRouteBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute> 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 L3vpnMcastRouteBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoute>> 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 newL3vpnMcastRoute
instance.- Returns:
- A new
L3vpnMcastRoute
instance.
-