Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv6.routes
Class Ipv6RoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.inet.rev180329.ipv6.routes.Ipv6RoutesBuilder
-
@Generated("mdsal-binding-generator") public class Ipv6RoutesBuilder extends Object
Class that buildsIpv6Routes
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:
Ipv6Routes createIpv6Routes(int fooXyzzy, int barBaz) { return new Ipv6RoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv6Routes, 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:
Ipv6Routes
- 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
-
-
Constructor Summary
Constructors Constructor Description Ipv6RoutesBuilder()
Construct an empty builder.Ipv6RoutesBuilder(Ipv6Routes base)
Construct a builder initialized with state from specifiedIpv6Routes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv6RoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Routes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Routes>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv6Routes
build()
A newIpv6Routes
instance.Map<Ipv6RouteKey,Ipv6Route>
getIpv6Route()
Return current value associated with the property corresponding toIpv6Routes.getIpv6Route()
.Ipv6RoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Routes>> augmentationType)
Remove an augmentation from this builder's product.Ipv6RoutesBuilder
setIpv6Route(Map<Ipv6RouteKey,Ipv6Route> values)
Set the property corresponding toIpv6Routes.getIpv6Route()
to the specified value.
-
-
-
Constructor Detail
-
Ipv6RoutesBuilder
public Ipv6RoutesBuilder()
Construct an empty builder.
-
Ipv6RoutesBuilder
public Ipv6RoutesBuilder(Ipv6Routes base)
Construct a builder initialized with state from specifiedIpv6Routes
.- Parameters:
base
- Ipv6Routes from which the builder should be initialized
-
-
Method Detail
-
getIpv6Route
public Map<Ipv6RouteKey,Ipv6Route> getIpv6Route()
Return current value associated with the property corresponding toIpv6Routes.getIpv6Route()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Routes>> 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
-
setIpv6Route
public Ipv6RoutesBuilder setIpv6Route(Map<Ipv6RouteKey,Ipv6Route> values)
Set the property corresponding toIpv6Routes.getIpv6Route()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv6RoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Routes> 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 Ipv6RoutesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6Routes>> 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 @NonNull Ipv6Routes build()
A newIpv6Routes
instance.- Returns:
- A new
Ipv6Routes
instance.
-
-