Class MpReachNlriBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.reach.MpReachNlriBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MpReachNlri>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MpReachNlri,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MpReachNlriBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MpReachNlri>
Class that buildsMpReachNlri
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:
MpReachNlri
,Builder
-
-
Constructor Summary
Constructors Constructor Description MpReachNlriBuilder()
MpReachNlriBuilder(MpReachNlri base)
MpReachNlriBuilder(BgpTableType arg)
MpReachNlriBuilder(NextHop arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MpReachNlriBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MpReachNlri> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MpReachNlri>>
E$$augmentation(Class<E$$> augmentationType)
MpReachNlri
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.AdvertizedRoutes
getAdvertizedRoutes()
Class<? extends AddressFamily>
getAfi()
CNextHop
getCNextHop()
Class<? extends SubsequentAddressFamily>
getSafi()
MpReachNlriBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MpReachNlri>> augmentationType)
Remove an augmentation from this builder's product.MpReachNlriBuilder
setAdvertizedRoutes(AdvertizedRoutes value)
MpReachNlriBuilder
setAfi(Class<? extends AddressFamily> value)
MpReachNlriBuilder
setCNextHop(CNextHop value)
MpReachNlriBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
-
-
-
Constructor Detail
-
MpReachNlriBuilder
public MpReachNlriBuilder()
-
MpReachNlriBuilder
public MpReachNlriBuilder(BgpTableType arg)
-
MpReachNlriBuilder
public MpReachNlriBuilder(NextHop arg)
-
MpReachNlriBuilder
public MpReachNlriBuilder(MpReachNlri base)
-
-
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:- NextHop
- BgpTableType
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAdvertizedRoutes
public AdvertizedRoutes getAdvertizedRoutes()
-
getAfi
public Class<? extends AddressFamily> getAfi()
-
getCNextHop
public CNextHop getCNextHop()
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MpReachNlri>> E$$ augmentation(Class<E$$> augmentationType)
-
setAdvertizedRoutes
public MpReachNlriBuilder setAdvertizedRoutes(AdvertizedRoutes value)
-
setAfi
public MpReachNlriBuilder setAfi(Class<? extends AddressFamily> value)
-
setCNextHop
public MpReachNlriBuilder setCNextHop(CNextHop value)
-
setSafi
public MpReachNlriBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
-
addAugmentation
public MpReachNlriBuilder addAugmentation(org.opendaylight.yangtools.yang.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.yang.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
public MpReachNlri build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MpReachNlri>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MpReachNlri,IllegalArgumentException>
-
-