Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case

Class DestinationLinkstateBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.linkstate.rev200120.update.attributes.mp.reach.nlri.advertized.routes.destination.type.destination.linkstate._case.DestinationLinkstateBuilder

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

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

   
     DestinationLinkstate createDestinationLinkstate(int fooXyzzy, int barBaz) {
         return new DestinationLinkstateBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• DestinationLinkstate

Constructor Summary

Constructors

Constructor	Description
DestinationLinkstateBuilder()	Construct an empty builder.
DestinationLinkstateBuilder(LinkstateDestination arg)	Construct a new builder initialized from specified LinkstateDestination.
DestinationLinkstateBuilder(DestinationLinkstate base)	Construct a builder initialized with state from specified DestinationLinkstate.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

DestinationLinkstateBuilder

public DestinationLinkstateBuilder()

Construct an empty builder.

DestinationLinkstateBuilder

public DestinationLinkstateBuilder(LinkstateDestination arg)

Construct a new builder initialized from specified LinkstateDestination.

Parameters:

arg - LinkstateDestination from which the builder should be initialized

DestinationLinkstateBuilder

public DestinationLinkstateBuilder(DestinationLinkstate base)

Construct a builder initialized with state from specified DestinationLinkstate.

Parameters:

base - DestinationLinkstate from which the builder should be initialized

Method Details

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:

• LinkstateDestination

Parameters:

arg - grouping object

Throws:

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

empty

public static @NonNull DestinationLinkstate empty()

Get empty instance of DestinationLinkstate.

Returns:

An empty DestinationLinkstate

getCLinkstateDestination

public List<CLinkstateDestination> getCLinkstateDestination()

Return current value associated with the property corresponding to LinkstateDestination.getCLinkstateDestination().

Returns:

current value

augmentation

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

setCLinkstateDestination

public DestinationLinkstateBuilder setCLinkstateDestination(List<CLinkstateDestination> values)

Set the property corresponding to LinkstateDestination.getCLinkstateDestination() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

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

A new DestinationLinkstate instance.

Returns:

A new DestinationLinkstate instance.