Class L3vpnMcastRoutesIpv6Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.l3vpn.mcast.routes.ipv6.L3vpnMcastRoutesIpv6Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoutesIpv6>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnMcastRoutesIpv6,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class L3vpnMcastRoutesIpv6Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoutesIpv6>
Class that buildsL3vpnMcastRoutesIpv6Builder
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:
L3vpnMcastRoutesIpv6Builder createTarget(int fooXyzzy, int barBaz) { return new L3vpnMcastRoutesIpv6BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L3vpnMcastRoutesIpv6Builder, 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 oportunities, 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:
L3vpnMcastRoutesIpv6Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L3vpnMcastRoutesIpv6Builder()
L3vpnMcastRoutesIpv6Builder(L3vpnMcastRoutesIpv6 base)
L3vpnMcastRoutesIpv6Builder(L3vpnMcastRoutes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description L3vpnMcastRoutesIpv6Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv6> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv6>>
E$$augmentation(Class<E$$> augmentationType)
L3vpnMcastRoutesIpv6
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<L3vpnMcastRouteKey,L3vpnMcastRoute>
getL3vpnMcastRoute()
L3vpnMcastRoutesIpv6Builder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv6>> augmentationType)
Remove an augmentation from this builder's product.L3vpnMcastRoutesIpv6Builder
setL3vpnMcastRoute(List<L3vpnMcastRoute> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vpnMcastRoute(Map)
instead.L3vpnMcastRoutesIpv6Builder
setL3vpnMcastRoute(Map<L3vpnMcastRouteKey,L3vpnMcastRoute> values)
-
-
-
Constructor Detail
-
L3vpnMcastRoutesIpv6Builder
public L3vpnMcastRoutesIpv6Builder()
-
L3vpnMcastRoutesIpv6Builder
public L3vpnMcastRoutesIpv6Builder(L3vpnMcastRoutes arg)
-
L3vpnMcastRoutesIpv6Builder
public L3vpnMcastRoutesIpv6Builder(L3vpnMcastRoutesIpv6 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastRoutes
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getL3vpnMcastRoute
public Map<L3vpnMcastRouteKey,L3vpnMcastRoute> getL3vpnMcastRoute()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv6>> E$$ augmentation(Class<E$$> augmentationType)
-
setL3vpnMcastRoute
public L3vpnMcastRoutesIpv6Builder setL3vpnMcastRoute(Map<L3vpnMcastRouteKey,L3vpnMcastRoute> values)
-
setL3vpnMcastRoute
@Deprecated(forRemoval=true) public L3vpnMcastRoutesIpv6Builder setL3vpnMcastRoute(List<L3vpnMcastRoute> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL3vpnMcastRoute(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the list contains entries with the same keyNullPointerException
- if the list contains a null entry
-
addAugmentation
public L3vpnMcastRoutesIpv6Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv6> 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 L3vpnMcastRoutesIpv6Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L3vpnMcastRoutesIpv6>> 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 L3vpnMcastRoutesIpv6 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<L3vpnMcastRoutesIpv6>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<L3vpnMcastRoutesIpv6,IllegalArgumentException>
-
-