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