Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.l3vpn.mcast.ipv6.advertized._case

Class DestinationIpv6L3vpnMcastBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.l3vpn.mcast.ipv6.advertized._case.DestinationIpv6L3vpnMcastBuilder

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

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

   
     DestinationIpv6L3vpnMcast createDestinationIpv6L3vpnMcast(int fooXyzzy, int barBaz) {
         return new DestinationIpv6L3vpnMcastBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

DestinationIpv6L3vpnMcast

Constructor Summary

Constructors

Constructor	Description
DestinationIpv6L3vpnMcastBuilder()	Construct an empty builder.
DestinationIpv6L3vpnMcastBuilder(L3vpnMcastDestination arg)	Construct a new builder initialized from specified L3vpnMcastDestination.
DestinationIpv6L3vpnMcastBuilder(DestinationIpv6L3vpnMcast base)	Construct a builder initialized with state from specified DestinationIpv6L3vpnMcast.

Method Summary

Modifier and Type	Method	Description
DestinationIpv6L3vpnMcastBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6L3vpnMcast> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6L3vpnMcast>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull DestinationIpv6L3vpnMcast	build()	A new DestinationIpv6L3vpnMcast instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
List<L3vpnMcastDestination>	getL3vpnMcastDestination()	Return current value associated with the property corresponding to L3vpnMcastDestination.getL3vpnMcastDestination().
DestinationIpv6L3vpnMcastBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6L3vpnMcast>> augmentationType)	Remove an augmentation from this builder's product.
DestinationIpv6L3vpnMcastBuilder	setL3vpnMcastDestination(List<L3vpnMcastDestination> values)	Set the property corresponding to L3vpnMcastDestination.getL3vpnMcastDestination() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

DestinationIpv6L3vpnMcastBuilder

public DestinationIpv6L3vpnMcastBuilder()

Construct an empty builder.

DestinationIpv6L3vpnMcastBuilder

public DestinationIpv6L3vpnMcastBuilder(L3vpnMcastDestination arg)

Construct a new builder initialized from specified L3vpnMcastDestination.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.l3vpn.mcast.rev180417.L3vpnMcastDestination from which the builder should be initialized

DestinationIpv6L3vpnMcastBuilder

public DestinationIpv6L3vpnMcastBuilder(DestinationIpv6L3vpnMcast base)

Construct a builder initialized with state from specified DestinationIpv6L3vpnMcast.

Parameters:

base - DestinationIpv6L3vpnMcast 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:

• L3vpnMcastDestination

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getL3vpnMcastDestination

public List<L3vpnMcastDestination> getL3vpnMcastDestination()

Return current value associated with the property corresponding to L3vpnMcastDestination.getL3vpnMcastDestination().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6L3vpnMcast>> 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

setL3vpnMcastDestination

public DestinationIpv6L3vpnMcastBuilder setL3vpnMcastDestination(List<L3vpnMcastDestination> values)

Set the property corresponding to L3vpnMcastDestination.getL3vpnMcastDestination() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

public DestinationIpv6L3vpnMcastBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6L3vpnMcast> 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 DestinationIpv6L3vpnMcastBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv6L3vpnMcast>> 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 DestinationIpv6L3vpnMcast build()

A new DestinationIpv6L3vpnMcast instance.

Returns:

A new DestinationIpv6L3vpnMcast instance.