Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.routes
Class EvpnRoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.routes.EvpnRoutesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<EvpnRoutes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<EvpnRoutes,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class EvpnRoutesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<EvpnRoutes>
Class that buildsEvpnRoutesBuilder
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:
EvpnRoutesBuilder createTarget(int fooXyzzy, int barBaz) { return new EvpnRoutesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of EvpnRoutesBuilder, 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:
EvpnRoutesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description EvpnRoutesBuilder()
EvpnRoutesBuilder(EvpnRoutes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description EvpnRoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoutes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoutes>>
E$$augmentation(Class<E$$> augmentationType)
EvpnRoutes
build()
Map<EvpnRouteKey,EvpnRoute>
getEvpnRoute()
EvpnRoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoutes>> augmentationType)
Remove an augmentation from this builder's product.EvpnRoutesBuilder
setEvpnRoute(List<EvpnRoute> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEvpnRoute(Map)
instead.EvpnRoutesBuilder
setEvpnRoute(Map<EvpnRouteKey,EvpnRoute> values)
-
-
-
Constructor Detail
-
EvpnRoutesBuilder
public EvpnRoutesBuilder()
-
EvpnRoutesBuilder
public EvpnRoutesBuilder(EvpnRoutes base)
-
-
Method Detail
-
getEvpnRoute
public Map<EvpnRouteKey,EvpnRoute> getEvpnRoute()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoutes>> E$$ augmentation(Class<E$$> augmentationType)
-
setEvpnRoute
public EvpnRoutesBuilder setEvpnRoute(Map<EvpnRouteKey,EvpnRoute> values)
-
setEvpnRoute
@Deprecated(forRemoval=true) public EvpnRoutesBuilder setEvpnRoute(List<EvpnRoute> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEvpnRoute(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 EvpnRoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoutes> 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 EvpnRoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<EvpnRoutes>> 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 EvpnRoutes build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<EvpnRoutes>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<EvpnRoutes,IllegalArgumentException>
-
-