Class MpUnreachNlriBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.attributes.unreach.MpUnreachNlriBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MpUnreachNlri>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MpUnreachNlri,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MpUnreachNlriBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MpUnreachNlri>
Class that buildsMpUnreachNlri
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:
MpUnreachNlri createMpUnreachNlri(int fooXyzzy, int barBaz) { return new MpUnreachNlriBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MpUnreachNlri, 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:
MpUnreachNlri
,Builder
-
-
Constructor Summary
Constructors Constructor Description MpUnreachNlriBuilder()
MpUnreachNlriBuilder(MpUnreachNlri base)
MpUnreachNlriBuilder(BgpTableType arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MpUnreachNlriBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MpUnreachNlri> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MpUnreachNlri>>
E$$augmentation(Class<E$$> augmentationType)
MpUnreachNlri
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
Class<? extends SubsequentAddressFamily>
getSafi()
WithdrawnRoutes
getWithdrawnRoutes()
MpUnreachNlriBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MpUnreachNlri>> augmentationType)
Remove an augmentation from this builder's product.MpUnreachNlriBuilder
setAfi(Class<? extends AddressFamily> value)
MpUnreachNlriBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
MpUnreachNlriBuilder
setWithdrawnRoutes(WithdrawnRoutes value)
-
-
-
Constructor Detail
-
MpUnreachNlriBuilder
public MpUnreachNlriBuilder()
-
MpUnreachNlriBuilder
public MpUnreachNlriBuilder(BgpTableType arg)
-
MpUnreachNlriBuilder
public MpUnreachNlriBuilder(MpUnreachNlri 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:- BgpTableType
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAfi
public Class<? extends AddressFamily> getAfi()
-
getSafi
public Class<? extends SubsequentAddressFamily> getSafi()
-
getWithdrawnRoutes
public WithdrawnRoutes getWithdrawnRoutes()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MpUnreachNlri>> E$$ augmentation(Class<E$$> augmentationType)
-
setAfi
public MpUnreachNlriBuilder setAfi(Class<? extends AddressFamily> value)
-
setSafi
public MpUnreachNlriBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
-
setWithdrawnRoutes
public MpUnreachNlriBuilder setWithdrawnRoutes(WithdrawnRoutes value)
-
addAugmentation
public MpUnreachNlriBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MpUnreachNlri> 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 MpUnreachNlriBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MpUnreachNlri>> 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 MpUnreachNlri build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MpUnreachNlri>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MpUnreachNlri,IllegalArgumentException>
-
-