Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group

Class AsPathOptionsBuilder

java.lang.Object

org.opendaylight.yangtools.binding.lib.AugmentableBuilder<AsPathOptions,AsPathOptionsBuilder>

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.AsPathOptionsBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Mutable

@Generated("mdsal-binding-generator")
public class AsPathOptionsBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<AsPathOptions,AsPathOptionsBuilder>

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

   
     AsPathOptions createAsPathOptions(int fooXyzzy, int barBaz) {
         return new AsPathOptionsBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• AsPathOptions

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@NonNull AsPathOptions	build()	Returns A new AsPathOptions instance.
static @NonNull AsPathOptions	empty()	Returns an empty AsPathOptions.
Config	getConfig()	Deprecated, for removal: This API element is subject to removal in a future version. This method will not be generated in a future release
State	getState()	Deprecated, for removal: This API element is subject to removal in a future version. This method will not be generated in a future release
AsPathOptionsBuilder	setConfig(Config value)	Set the property corresponding to AsPathOptions.getConfig() to the specified value.
AsPathOptionsBuilder	setState(State value)	Set the property corresponding to AsPathOptions.getState() to the specified value.

Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder

addAugmentation, augmentation, augmentations, removeAugmentation

Methods inherited from class java.lang.Object

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

Constructor Details

AsPathOptionsBuilder

public AsPathOptionsBuilder()

Construct an empty builder.

AsPathOptionsBuilder

public AsPathOptionsBuilder(AsPathOptions base)

Construct a builder initialized with state from specified AsPathOptions.

Parameters:

base - AsPathOptions from which the builder should be initialized

Method Details

empty

public static @NonNull AsPathOptions empty()

Returns an empty AsPathOptions.

Returns:

an empty AsPathOptions

getConfig

@Deprecated(forRemoval=true)
public Config getConfig()

Deprecated, for removal: This API element is subject to removal in a future version.

This method will not be generated in a future release

Return current value associated with the property corresponding to AsPathOptions.getConfig().

Returns:

current value

getState

@Deprecated(forRemoval=true)
public State getState()

Deprecated, for removal: This API element is subject to removal in a future version.

This method will not be generated in a future release

Return current value associated with the property corresponding to AsPathOptions.getState().

Returns:

current value

setConfig

public AsPathOptionsBuilder setConfig(Config value)

Set the property corresponding to AsPathOptions.getConfig() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setState

public AsPathOptionsBuilder setState(State value)

Set the property corresponding to AsPathOptions.getState() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull AsPathOptions build()

Returns A new AsPathOptions instance.

Returns:

A new AsPathOptions instance