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