Class DestinationMvpnIpv4AdvertizedCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.ipv4.rev180417.update.attributes.mp.reach.nlri.advertized.routes.destination.type.DestinationMvpnIpv4AdvertizedCaseBuilder
-
@Generated("mdsal-binding-generator") public class DestinationMvpnIpv4AdvertizedCaseBuilder extends Object
Class that buildsDestinationMvpnIpv4AdvertizedCase
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:
DestinationMvpnIpv4AdvertizedCase createDestinationMvpnIpv4AdvertizedCase(int fooXyzzy, int barBaz) { return new DestinationMvpnIpv4AdvertizedCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DestinationMvpnIpv4AdvertizedCase, 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:
DestinationMvpnIpv4AdvertizedCase
- 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 DestinationMvpnIpv4AdvertizedCaseBuilder()
Construct an empty builder.DestinationMvpnIpv4AdvertizedCaseBuilder(DestinationMvpnIpv4AdvertizedCase base)
Construct a builder initialized with state from specifiedDestinationMvpnIpv4AdvertizedCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DestinationMvpnIpv4AdvertizedCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationMvpnIpv4AdvertizedCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationMvpnIpv4AdvertizedCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DestinationMvpnIpv4AdvertizedCase
build()
A newDestinationMvpnIpv4AdvertizedCase
instance.DestinationMvpn
getDestinationMvpn()
Return current value associated with the property corresponding toDestinationMvpnIpv4AdvertizedCase.getDestinationMvpn()
.DestinationMvpnIpv4AdvertizedCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationMvpnIpv4AdvertizedCase>> augmentationType)
Remove an augmentation from this builder's product.DestinationMvpnIpv4AdvertizedCaseBuilder
setDestinationMvpn(DestinationMvpn value)
Set the property corresponding toDestinationMvpnIpv4AdvertizedCase.getDestinationMvpn()
to the specified value.
-
-
-
Constructor Detail
-
DestinationMvpnIpv4AdvertizedCaseBuilder
public DestinationMvpnIpv4AdvertizedCaseBuilder()
Construct an empty builder.
-
DestinationMvpnIpv4AdvertizedCaseBuilder
public DestinationMvpnIpv4AdvertizedCaseBuilder(DestinationMvpnIpv4AdvertizedCase base)
Construct a builder initialized with state from specifiedDestinationMvpnIpv4AdvertizedCase
.- Parameters:
base
- DestinationMvpnIpv4AdvertizedCase from which the builder should be initialized
-
-
Method Detail
-
getDestinationMvpn
public DestinationMvpn getDestinationMvpn()
Return current value associated with the property corresponding toDestinationMvpnIpv4AdvertizedCase.getDestinationMvpn()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationMvpnIpv4AdvertizedCase>> 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
-
setDestinationMvpn
public DestinationMvpnIpv4AdvertizedCaseBuilder setDestinationMvpn(DestinationMvpn value)
Set the property corresponding toDestinationMvpnIpv4AdvertizedCase.getDestinationMvpn()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DestinationMvpnIpv4AdvertizedCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationMvpnIpv4AdvertizedCase> 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 DestinationMvpnIpv4AdvertizedCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationMvpnIpv4AdvertizedCase>> 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 DestinationMvpnIpv4AdvertizedCase build()
A newDestinationMvpnIpv4AdvertizedCase
instance.- Returns:
- A new
DestinationMvpnIpv4AdvertizedCase
instance.
-
-