Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.exclude.route.object

Class ExcludeRouteObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.exclude.route.object.ExcludeRouteObjectBuilder

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

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

   
     ExcludeRouteObject createExcludeRouteObject(int fooXyzzy, int barBaz) {
         return new ExcludeRouteObjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• ExcludeRouteObject

Constructor Summary

Constructors

Constructor	Description
ExcludeRouteObjectBuilder()	Construct an empty builder.
ExcludeRouteObjectBuilder(ExcludeRouteObject base)	Construct a builder initialized with state from specified ExcludeRouteObject.

Method Summary

Modifier and Type	Method	Description
ExcludeRouteObjectBuilder	addAugmentation(org.opendaylight.yangtools.binding.Augmentation<ExcludeRouteObject> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.binding.Augmentation<ExcludeRouteObject>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull ExcludeRouteObject	build()	A new ExcludeRouteObject instance.
static @NonNull ExcludeRouteObject	empty()	Get empty instance of ExcludeRouteObject.
List<SubobjectContainer>	getSubobjectContainer()	Return current value associated with the property corresponding to ExcludeRouteObject.getSubobjectContainer().
ExcludeRouteObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<ExcludeRouteObject>> augmentationType)	Remove an augmentation from this builder's product.
ExcludeRouteObjectBuilder	setSubobjectContainer(List<SubobjectContainer> values)	Set the property corresponding to ExcludeRouteObject.getSubobjectContainer() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

ExcludeRouteObjectBuilder

public ExcludeRouteObjectBuilder()

Construct an empty builder.

ExcludeRouteObjectBuilder

public ExcludeRouteObjectBuilder(ExcludeRouteObject base)

Construct a builder initialized with state from specified ExcludeRouteObject.

Parameters:

base - ExcludeRouteObject from which the builder should be initialized

Method Details

empty

public static @NonNull ExcludeRouteObject empty()

Get empty instance of ExcludeRouteObject.

Returns:

An empty ExcludeRouteObject

getSubobjectContainer

public List<SubobjectContainer> getSubobjectContainer()

Return current value associated with the property corresponding to ExcludeRouteObject.getSubobjectContainer().

Returns:

current value

augmentation

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

setSubobjectContainer

public ExcludeRouteObjectBuilder setSubobjectContainer(List<SubobjectContainer> values)

Set the property corresponding to ExcludeRouteObject.getSubobjectContainer() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

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

A new ExcludeRouteObject instance.

Returns:

A new ExcludeRouteObject instance.