Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.multiprotocol.rev180329.mp.capabilities.add.path.capability

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

@Generated("mdsal-binding-generator")
public class AddressFamiliesBuilder
extends Object

Class that builds AddressFamilies 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:

   
     AddressFamilies createAddressFamilies(int fooXyzzy, int barBaz) {
         return new AddressFamiliesBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of AddressFamilies, 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:

AddressFamilies

Constructor Summary

Constructors

Constructor	Description
AddressFamiliesBuilder()	Construct an empty builder.
AddressFamiliesBuilder(BgpAddPathTableType arg)	Construct a new builder initialized from specified BgpAddPathTableType.
AddressFamiliesBuilder(BgpTableType arg)	Construct a new builder initialized from specified BgpTableType.
AddressFamiliesBuilder(AddressFamilies base)	Construct a builder initialized with state from specified AddressFamilies.

Method Summary

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)	Return the specified augmentation, if it is present in this builder.
@NonNull AddressFamilies	build()	A new AddressFamilies instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Class<? extends AddressFamily>	getAfi()	Return current value associated with the property corresponding to BgpTableType.getAfi().
Class<? extends SubsequentAddressFamily>	getSafi()	Return current value associated with the property corresponding to BgpTableType.getSafi().
SendReceive	getSendReceive()	Return current value associated with the property corresponding to BgpAddPathTableType.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)	Set the property corresponding to BgpTableType.getAfi() to the specified value.
AddressFamiliesBuilder	setSafi(Class<? extends SubsequentAddressFamily> value)	Set the property corresponding to BgpTableType.getSafi() to the specified value.
AddressFamiliesBuilder	setSendReceive(SendReceive value)	Set the property corresponding to BgpAddPathTableType.getSendReceive() to the specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddressFamiliesBuilder

public AddressFamiliesBuilder()

Construct an empty builder.

AddressFamiliesBuilder

public AddressFamiliesBuilder(BgpAddPathTableType arg)

Construct a new builder initialized from specified BgpAddPathTableType.

Parameters:

arg - BgpAddPathTableType from which the builder should be initialized

AddressFamiliesBuilder

public AddressFamiliesBuilder(BgpTableType arg)

Construct a new builder initialized from specified BgpTableType.

Parameters:

arg - BgpTableType from which the builder should be initialized

AddressFamiliesBuilder

public AddressFamiliesBuilder(AddressFamilies base)

Construct a builder initialized with state from specified AddressFamilies.

Parameters:

base - AddressFamilies from which the builder should be initialized

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
• 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()

Return current value associated with the property corresponding to BgpTableType.getAfi().

Returns:

current value

getSafi

public Class<? extends SubsequentAddressFamily> getSafi()

Return current value associated with the property corresponding to BgpTableType.getSafi().

Returns:

current value

getSendReceive

public SendReceive getSendReceive()

Return current value associated with the property corresponding to BgpAddPathTableType.getSendReceive().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<AddressFamilies>> 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 - if augmentType is null

setAfi

public AddressFamiliesBuilder setAfi(Class<? extends AddressFamily> value)

Set the property corresponding to BgpTableType.getAfi() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setSafi

public AddressFamiliesBuilder setSafi(Class<? extends SubsequentAddressFamily> value)

Set the property corresponding to BgpTableType.getSafi() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setSendReceive

public AddressFamiliesBuilder setSendReceive(SendReceive value)

Set the property corresponding to BgpAddPathTableType.getSendReceive() to the specified value.

Parameters:

value - desired value

Returns:

this builder

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 - if augmentation 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 @NonNull AddressFamilies build()

A new AddressFamilies instance.

Returns:

A new AddressFamilies instance.