Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.ipv4.routes
Class Ipv4RoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.ipv4.routes.Ipv4RoutesBuilder
-
@Generated("mdsal-binding-generator") public class Ipv4RoutesBuilder extends Object
Class that buildsIpv4Routes
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:
Ipv4Routes createIpv4Routes(int fooXyzzy, int barBaz) { return new Ipv4RoutesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4Routes, 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:
Ipv4Routes
- 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 Ipv4RoutesBuilder()
Construct an empty builder.Ipv4RoutesBuilder(Ipv4Routes base)
Construct a builder initialized with state from specifiedIpv4Routes
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv4Routes
build()
A newIpv4Routes
instance.Map<Ipv4RouteKey,Ipv4Route>
getIpv4Route()
Return current value associated with the property corresponding toIpv4Routes.getIpv4Route()
.Ipv4RoutesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Routes>> augmentationType)
Remove an augmentation from this builder's product.Ipv4RoutesBuilder
setIpv4Route(Map<Ipv4RouteKey,Ipv4Route> values)
Set the property corresponding toIpv4Routes.getIpv4Route()
to the specified value.
-
-
-
Constructor Detail
-
Ipv4RoutesBuilder
public Ipv4RoutesBuilder()
Construct an empty builder.
-
Ipv4RoutesBuilder
public Ipv4RoutesBuilder(Ipv4Routes base)
Construct a builder initialized with state from specifiedIpv4Routes
.- Parameters:
base
- Ipv4Routes from which the builder should be initialized
-
-
Method Detail
-
getIpv4Route
public Map<Ipv4RouteKey,Ipv4Route> getIpv4Route()
Return current value associated with the property corresponding toIpv4Routes.getIpv4Route()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Routes>> 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
-
setIpv4Route
public Ipv4RoutesBuilder setIpv4Route(Map<Ipv4RouteKey,Ipv4Route> values)
Set the property corresponding toIpv4Routes.getIpv4Route()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
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 @NonNull Ipv4Routes build()
A newIpv4Routes
instance.- Returns:
- A new
Ipv4Routes
instance.
-
-