Class MpReachNlriBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder
Class that builds
MpReachNlri
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:
MpReachNlri createMpReachNlri(int fooXyzzy, int barBaz) {
return new MpReachNlriBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MpReachNlri, 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 specifiedMpReachNlri
.Construct a new builder initialized from specifiedBgpTableType
.Construct a new builder initialized from specifiedNextHop
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<MpReachNlri> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<MpReachNlri>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MpReachNlri
build()
A newMpReachNlri
instance.static @NonNull MpReachNlri
empty()
Get empty instance of MpReachNlri.void
fieldsFrom
(org.opendaylight.yangtools.binding.Grouping arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMpReachNlri.getAdvertizedRoutes()
.getAfi()
Return current value associated with the property corresponding toBgpTableType.getAfi()
.Return current value associated with the property corresponding toNextHop.getCNextHop()
.getSafi()
Return current value associated with the property corresponding toBgpTableType.getSafi()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<MpReachNlri>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toMpReachNlri.getAdvertizedRoutes()
to the specified value.setAfi
(AddressFamily value) Set the property corresponding toBgpTableType.getAfi()
to the specified value.setCNextHop
(CNextHop value) Set the property corresponding toNextHop.getCNextHop()
to the specified value.setSafi
(SubsequentAddressFamily value) Set the property corresponding toBgpTableType.getSafi()
to the specified value.
-
Constructor Details
-
MpReachNlriBuilder
public MpReachNlriBuilder()Construct an empty builder. -
MpReachNlriBuilder
Construct a new builder initialized from specifiedBgpTableType
.- Parameters:
arg
- BgpTableType from which the builder should be initialized
-
MpReachNlriBuilder
Construct a new builder initialized from specifiedNextHop
.- Parameters:
arg
- NextHop from which the builder should be initialized
-
MpReachNlriBuilder
Construct a builder initialized with state from specifiedMpReachNlri
.- Parameters:
base
- MpReachNlri 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 MpReachNlri.- Returns:
- An empty
MpReachNlri
-
getAdvertizedRoutes
Return current value associated with the property corresponding toMpReachNlri.getAdvertizedRoutes()
.- Returns:
- current value
-
getAfi
Return current value associated with the property corresponding toBgpTableType.getAfi()
.- Returns:
- current value
-
getCNextHop
Return current value associated with the property corresponding toNextHop.getCNextHop()
.- Returns:
- current value
-
getSafi
Return current value associated with the property corresponding toBgpTableType.getSafi()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<MpReachNlri>> 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
-
setAdvertizedRoutes
Set the property corresponding toMpReachNlri.getAdvertizedRoutes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setAfi
Set the property corresponding toBgpTableType.getAfi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCNextHop
Set the property corresponding toNextHop.getCNextHop()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSafi
Set the property corresponding toBgpTableType.getSafi()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MpReachNlriBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<MpReachNlri> 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 MpReachNlriBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<MpReachNlri>> 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 newMpReachNlri
instance.- Returns:
- A new
MpReachNlri
instance.
-