Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.key.container

Class MapRegisterCacheKeyBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.key.container.MapRegisterCacheKeyBuilder

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

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

   
     MapRegisterCacheKey createMapRegisterCacheKey(int fooXyzzy, int barBaz) {
         return new MapRegisterCacheKeyBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• MapRegisterCacheKey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MapRegisterCacheKeyBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull MapRegisterCacheKey	build()	A new MapRegisterCacheKey instance.
static @NonNull MapRegisterCacheKey	empty()	Get empty instance of MapRegisterCacheKey.
byte[]	getEidPrefix()	Return current value associated with the property corresponding to MapRegisterCacheKey.getEidPrefix().
byte[]	getSiteId()	Return current value associated with the property corresponding to MapRegisterCacheKey.getSiteId().
byte[]	getXtrId()	Return current value associated with the property corresponding to MapRegisterCacheKey.getXtrId().
MapRegisterCacheKeyBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey>> augmentationType)	Remove an augmentation from this builder's product.
MapRegisterCacheKeyBuilder	setEidPrefix(byte[] value)	Set the property corresponding to MapRegisterCacheKey.getEidPrefix() to the specified value.
MapRegisterCacheKeyBuilder	setSiteId(byte[] value)	Set the property corresponding to MapRegisterCacheKey.getSiteId() to the specified value.
MapRegisterCacheKeyBuilder	setXtrId(byte[] value)	Set the property corresponding to MapRegisterCacheKey.getXtrId() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

MapRegisterCacheKeyBuilder

public MapRegisterCacheKeyBuilder()

Construct an empty builder.

MapRegisterCacheKeyBuilder

public MapRegisterCacheKeyBuilder(MapRegisterCacheKey base)

Construct a builder initialized with state from specified MapRegisterCacheKey.

Parameters:

base - MapRegisterCacheKey from which the builder should be initialized

Method Details

empty

public static @NonNull MapRegisterCacheKey empty()

Get empty instance of MapRegisterCacheKey.

Returns:

An empty MapRegisterCacheKey

getEidPrefix

public byte[] getEidPrefix()

Return current value associated with the property corresponding to MapRegisterCacheKey.getEidPrefix().

Returns:

current value

getSiteId

public byte[] getSiteId()

Return current value associated with the property corresponding to MapRegisterCacheKey.getSiteId().

Returns:

current value

getXtrId

public byte[] getXtrId()

Return current value associated with the property corresponding to MapRegisterCacheKey.getXtrId().

Returns:

current value

augmentation

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

setEidPrefix

public MapRegisterCacheKeyBuilder setEidPrefix(byte[] value)

Set the property corresponding to MapRegisterCacheKey.getEidPrefix() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setSiteId

public MapRegisterCacheKeyBuilder setSiteId(byte[] value)

Set the property corresponding to MapRegisterCacheKey.getSiteId() to the specified value.

Parameters:

value - desired value

Returns:

this builder

setXtrId

public MapRegisterCacheKeyBuilder setXtrId(byte[] value)

Set the property corresponding to MapRegisterCacheKey.getXtrId() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new MapRegisterCacheKey instance.

Returns:

A new MapRegisterCacheKey instance.