Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set

Class NeighborSetBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.http.openconfig.net.yang.routing.policy.rev151009.neighbor.set.NeighborSetBuilder

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

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

   
     NeighborSet createNeighborSet(int fooXyzzy, int barBaz) {
         return new NeighborSetBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

NeighborSet

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
NeighborSetBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull NeighborSet	build()	A new NeighborSet instance.
Map<NeighborKey,Neighbor>	getNeighbor()	Return current value associated with the property corresponding to NeighborSet.getNeighbor().
String	getNeighborSetName()	Return current value associated with the property corresponding to NeighborSet.getNeighborSetName().
NeighborSetKey	key()	Return current value associated with the property corresponding to NeighborSet.key().
NeighborSetBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<NeighborSet>> augmentationType)	Remove an augmentation from this builder's product.
NeighborSetBuilder	setNeighbor(Map<NeighborKey,Neighbor> values)	Set the property corresponding to NeighborSet.getNeighbor() to the specified value.
NeighborSetBuilder	setNeighborSetName(String value)	Set the property corresponding to NeighborSet.getNeighborSetName() to the specified value.
NeighborSetBuilder	withKey(NeighborSetKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

NeighborSetBuilder

public NeighborSetBuilder()

Construct an empty builder.

NeighborSetBuilder

public NeighborSetBuilder(NeighborSet base)

Construct a builder initialized with state from specified NeighborSet.

Parameters:

base - NeighborSet from which the builder should be initialized

Method Detail

key

public NeighborSetKey key()

Return current value associated with the property corresponding to NeighborSet.key().

Returns:

current value

getNeighbor

public Map<NeighborKey,Neighbor> getNeighbor()

Return current value associated with the property corresponding to NeighborSet.getNeighbor().

Returns:

current value

getNeighborSetName

public String getNeighborSetName()

Return current value associated with the property corresponding to NeighborSet.getNeighborSetName().

Returns:

current value

augmentation

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

withKey

public NeighborSetBuilder withKey(NeighborSetKey key)

setNeighbor

public NeighborSetBuilder setNeighbor(Map<NeighborKey,Neighbor> values)

Set the property corresponding to NeighborSet.getNeighbor() to the specified value.

Parameters:

values - desired value

Returns:

this builder

setNeighborSetName

public NeighborSetBuilder setNeighborSetName(String value)

Set the property corresponding to NeighborSet.getNeighborSetName() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new NeighborSet instance.

Returns:

A new NeighborSet instance.