Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.c.parameters

Class BgpExtendedMessageCapabilityBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.open.message.bgp.parameters.optional.capabilities.c.parameters.BgpExtendedMessageCapabilityBuilder

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

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

   
     BgpExtendedMessageCapability createBgpExtendedMessageCapability(int fooXyzzy, int barBaz) {
         return new BgpExtendedMessageCapabilityBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• BgpExtendedMessageCapability

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
BgpExtendedMessageCapabilityBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<BgpExtendedMessageCapability> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpExtendedMessageCapability>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull BgpExtendedMessageCapability	build()	A new BgpExtendedMessageCapability instance.
BgpExtendedMessageCapabilityBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<BgpExtendedMessageCapability>> augmentationType)	Remove an augmentation from this builder's product.

Methods inherited from class java.lang.Object

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

Constructor Details

BgpExtendedMessageCapabilityBuilder

public BgpExtendedMessageCapabilityBuilder()

Construct an empty builder.

BgpExtendedMessageCapabilityBuilder

public BgpExtendedMessageCapabilityBuilder(BgpExtendedMessageCapability base)

Construct a builder initialized with state from specified BgpExtendedMessageCapability.

Parameters:

base - BgpExtendedMessageCapability from which the builder should be initialized

Method Details

augmentation

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

addAugmentation

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

A new BgpExtendedMessageCapability instance.

Returns:

A new BgpExtendedMessageCapability instance.