Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.bgp.rib.rib.peer.effective.rib.in.tables.routes

Class LabeledUnicastRoutesCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.bgp.rib.rib.peer.effective.rib.in.tables.routes.LabeledUnicastRoutesCaseBuilder

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

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

   
     LabeledUnicastRoutesCase createLabeledUnicastRoutesCase(int fooXyzzy, int barBaz) {
         return new LabeledUnicastRoutesCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

LabeledUnicastRoutesCase

Constructor Summary

Constructors

Constructor	Description
LabeledUnicastRoutesCaseBuilder()	Construct an empty builder.
LabeledUnicastRoutesCaseBuilder(LabeledUnicastRoutesCase base)	Construct a builder initialized with state from specified LabeledUnicastRoutesCase.
LabeledUnicastRoutesCaseBuilder(LabeledUnicastRoutes arg)	Construct a new builder initialized from specified LabeledUnicastRoutes.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LabeledUnicastRoutesCaseBuilder

public LabeledUnicastRoutesCaseBuilder()

Construct an empty builder.

LabeledUnicastRoutesCaseBuilder

public LabeledUnicastRoutesCaseBuilder(LabeledUnicastRoutes arg)

Construct a new builder initialized from specified LabeledUnicastRoutes.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.labeled.unicast.rev180329.LabeledUnicastRoutes from which the builder should be initialized

LabeledUnicastRoutesCaseBuilder

public LabeledUnicastRoutesCaseBuilder(LabeledUnicastRoutesCase base)

Construct a builder initialized with state from specified LabeledUnicastRoutesCase.

Parameters:

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

• LabeledUnicastRoutes

Parameters:

arg - grouping object

Throws:

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

getLabeledUnicastRoutes

public LabeledUnicastRoutes getLabeledUnicastRoutes()

Return current value associated with the property corresponding to LabeledUnicastRoutes.getLabeledUnicastRoutes().

Returns:

current value

augmentation

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

setLabeledUnicastRoutes

public LabeledUnicastRoutesCaseBuilder setLabeledUnicastRoutes(LabeledUnicastRoutes value)

Set the property corresponding to LabeledUnicastRoutes.getLabeledUnicastRoutes() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new LabeledUnicastRoutesCase instance.

Returns:

A new LabeledUnicastRoutesCase instance.