Class Ipv4RoutesCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.bgp.rib.rib.peer.adj.rib.out.tables.routes.Ipv4RoutesCaseBuilder
-
@Generated("mdsal-binding-generator") public class Ipv4RoutesCaseBuilder extends Object
Class that buildsIpv4RoutesCase
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:
Ipv4RoutesCase createIpv4RoutesCase(int fooXyzzy, int barBaz) { return new Ipv4RoutesCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4RoutesCase, 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:
Ipv4RoutesCase
- 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 Ipv4RoutesCaseBuilder()
Construct an empty builder.Ipv4RoutesCaseBuilder(Ipv4RoutesCase base)
Construct a builder initialized with state from specifiedIpv4RoutesCase
.Ipv4RoutesCaseBuilder(Ipv4Routes arg)
Construct a new builder initialized from specifiedIpv4Routes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv4RoutesCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4RoutesCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4RoutesCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Ipv4RoutesCase
build()
A newIpv4RoutesCase
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Ipv4Routes
getIpv4Routes()
Return current value associated with the property corresponding toIpv4Routes.getIpv4Routes()
.Ipv4RoutesCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4RoutesCase>> augmentationType)
Remove an augmentation from this builder's product.Ipv4RoutesCaseBuilder
setIpv4Routes(Ipv4Routes value)
Set the property corresponding toIpv4Routes.getIpv4Routes()
to the specified value.
-
-
-
Constructor Detail
-
Ipv4RoutesCaseBuilder
public Ipv4RoutesCaseBuilder()
Construct an empty builder.
-
Ipv4RoutesCaseBuilder
public Ipv4RoutesCaseBuilder(Ipv4Routes arg)
Construct a new builder initialized from specifiedIpv4Routes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.Ipv4Routes from which the builder should be initialized
-
Ipv4RoutesCaseBuilder
public Ipv4RoutesCaseBuilder(Ipv4RoutesCase base)
Construct a builder initialized with state from specifiedIpv4RoutesCase
.- Parameters:
base
- Ipv4RoutesCase from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpv4Routes
public Ipv4Routes getIpv4Routes()
Return current value associated with the property corresponding toIpv4Routes.getIpv4Routes()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4RoutesCase>> 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
-
setIpv4Routes
public Ipv4RoutesCaseBuilder setIpv4Routes(Ipv4Routes value)
Set the property corresponding toIpv4Routes.getIpv4Routes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv4RoutesCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4RoutesCase> 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 Ipv4RoutesCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4RoutesCase>> 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 Ipv4RoutesCase build()
A newIpv4RoutesCase
instance.- Returns:
- A new
Ipv4RoutesCase
instance.
-
-