Class MvpnRoutesIpv4Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.ipv4.rev180417.mvpn.routes.ipv4.MvpnRoutesIpv4Builder
Class that builds
MvpnRoutesIpv4
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:
MvpnRoutesIpv4 createMvpnRoutesIpv4(int fooXyzzy, int barBaz) {
return new MvpnRoutesIpv4Builder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MvpnRoutesIpv4, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMvpnRoutesIpv4
.Construct a new builder initialized from specifiedMvpnRoutes
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<MvpnRoutesIpv4> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<MvpnRoutesIpv4>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MvpnRoutesIpv4
build()
A newMvpnRoutesIpv4
instance.static @NonNull MvpnRoutesIpv4
empty()
Get empty instance of MvpnRoutesIpv4.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMvpnRoutes.getMvpnRoute()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<MvpnRoutesIpv4>> augmentationType) Remove an augmentation from this builder's product.setMvpnRoute
(Map<MvpnRouteKey, MvpnRoute> values) Set the property corresponding toMvpnRoutes.getMvpnRoute()
to the specified value.
-
Constructor Details
-
MvpnRoutesIpv4Builder
public MvpnRoutesIpv4Builder()Construct an empty builder. -
MvpnRoutesIpv4Builder
Construct a new builder initialized from specifiedMvpnRoutes
.- Parameters:
arg
- MvpnRoutes from which the builder should be initialized
-
MvpnRoutesIpv4Builder
Construct a builder initialized with state from specifiedMvpnRoutesIpv4
.- Parameters:
base
- MvpnRoutesIpv4 from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.binding.Grouping 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
-
empty
Get empty instance of MvpnRoutesIpv4.- Returns:
- An empty
MvpnRoutesIpv4
-
getMvpnRoute
Return current value associated with the property corresponding toMvpnRoutes.getMvpnRoute()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<MvpnRoutesIpv4>> 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
-
setMvpnRoute
Set the property corresponding toMvpnRoutes.getMvpnRoute()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MvpnRoutesIpv4Builder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<MvpnRoutesIpv4> 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 MvpnRoutesIpv4Builder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<MvpnRoutesIpv4>> 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
A newMvpnRoutesIpv4
instance.- Returns:
- A new
MvpnRoutesIpv4
instance.
-