Class AddressFamiliesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability.AddressFamiliesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<AddressFamilies>
,org.opendaylight.yangtools.concepts.CheckedBuilder<AddressFamilies,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AddressFamiliesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<AddressFamilies>
Class that buildsAddressFamiliesBuilder
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:
AddressFamiliesBuilder createTarget(int fooXyzzy, int barBaz) { return new AddressFamiliesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of AddressFamiliesBuilder, 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 oportunities, 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:
AddressFamiliesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description AddressFamiliesBuilder()
AddressFamiliesBuilder(BgpAddPathTableType arg)
AddressFamiliesBuilder(BgpTableType arg)
AddressFamiliesBuilder(AddressFamilies base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AddressFamiliesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies>>
E$$augmentation(Class<E$$> augmentationType)
AddressFamilies
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends AddressFamily>
getAfi()
Class<? extends SubsequentAddressFamily>
getSafi()
SendReceive
getSendReceive()
AddressFamiliesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies>> augmentationType)
Remove an augmentation from this builder's product.AddressFamiliesBuilder
setAfi(Class<? extends AddressFamily> value)
AddressFamiliesBuilder
setSafi(Class<? extends SubsequentAddressFamily> value)
AddressFamiliesBuilder
setSendReceive(SendReceive value)
-
-
-
Constructor Detail
-
AddressFamiliesBuilder
public AddressFamiliesBuilder()
-
AddressFamiliesBuilder
public AddressFamiliesBuilder(BgpAddPathTableType arg)
-
AddressFamiliesBuilder
public AddressFamiliesBuilder(BgpTableType arg)
-
AddressFamiliesBuilder
public AddressFamiliesBuilder(AddressFamilies 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpTableType
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.BgpAddPathTableType
- 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()
-
getSendReceive
public SendReceive getSendReceive()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies>> E$$ augmentation(Class<E$$> augmentationType)
-
setAfi
public AddressFamiliesBuilder setAfi(Class<? extends AddressFamily> value)
-
setSafi
public AddressFamiliesBuilder setSafi(Class<? extends SubsequentAddressFamily> value)
-
setSendReceive
public AddressFamiliesBuilder setSendReceive(SendReceive value)
-
addAugmentation
public AddressFamiliesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies> 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 AddressFamiliesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies>> 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 AddressFamilies build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<AddressFamilies>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<AddressFamilies,IllegalArgumentException>
-
-