Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.bandwidth.object.bandwidth.object.basic.bandwidth.object._case

Class BasicBandwidthObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.bandwidth.object.bandwidth.object.basic.bandwidth.object._case.BasicBandwidthObjectBuilder

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

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

   
     BasicBandwidthObject createBasicBandwidthObject(int fooXyzzy, int barBaz) {
         return new BasicBandwidthObjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• BasicBandwidthObject

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

BasicBandwidthObjectBuilder

public BasicBandwidthObjectBuilder()

Construct an empty builder.

BasicBandwidthObjectBuilder

public BasicBandwidthObjectBuilder(BasicBandwidthObject base)

Construct a builder initialized with state from specified BasicBandwidthObject.

Parameters:

base - BasicBandwidthObject from which the builder should be initialized

Method Details

empty

public static @NonNull BasicBandwidthObject empty()

Get empty instance of BasicBandwidthObject.

Returns:

An empty BasicBandwidthObject

getBandwidth

public Bandwidth getBandwidth()

Return current value associated with the property corresponding to BasicBandwidthObject.getBandwidth().

Returns:

current value

augmentation

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

setBandwidth

public BasicBandwidthObjectBuilder setBandwidth(Bandwidth value)

Set the property corresponding to BasicBandwidthObject.getBandwidth() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new BasicBandwidthObject instance.

Returns:

A new BasicBandwidthObject instance.