Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community

Class LinkBandwidthCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.types.rev200120.extended.community.extended.community.LinkBandwidthCaseBuilder

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

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

   
     LinkBandwidthCase createLinkBandwidthCase(int fooXyzzy, int barBaz) {
         return new LinkBandwidthCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• LinkBandwidthCase

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
LinkBandwidthCaseBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LinkBandwidthCase> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkBandwidthCase>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull LinkBandwidthCase	build()	A new LinkBandwidthCase instance.
LinkBandwidthExtendedCommunity	getLinkBandwidthExtendedCommunity()	Return current value associated with the property corresponding to LinkBandwidthCase.getLinkBandwidthExtendedCommunity().
LinkBandwidthCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LinkBandwidthCase>> augmentationType)	Remove an augmentation from this builder's product.
LinkBandwidthCaseBuilder	setLinkBandwidthExtendedCommunity(LinkBandwidthExtendedCommunity value)	Set the property corresponding to LinkBandwidthCase.getLinkBandwidthExtendedCommunity() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

LinkBandwidthCaseBuilder

public LinkBandwidthCaseBuilder()

Construct an empty builder.

LinkBandwidthCaseBuilder

public LinkBandwidthCaseBuilder(LinkBandwidthCase base)

Construct a builder initialized with state from specified LinkBandwidthCase.

Parameters:

base - LinkBandwidthCase from which the builder should be initialized

Method Details

getLinkBandwidthExtendedCommunity

public LinkBandwidthExtendedCommunity getLinkBandwidthExtendedCommunity()

Return current value associated with the property corresponding to LinkBandwidthCase.getLinkBandwidthExtendedCommunity().

Returns:

current value

augmentation

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

setLinkBandwidthExtendedCommunity

public LinkBandwidthCaseBuilder setLinkBandwidthExtendedCommunity(LinkBandwidthExtendedCommunity value)

Set the property corresponding to LinkBandwidthCase.getLinkBandwidthExtendedCommunity() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new LinkBandwidthCase instance.

Returns:

A new LinkBandwidthCase instance.