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 java.lang.Object
Class that buildsMapRegisterCacheKey
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
- 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
-
-
Constructor Summary
Constructors Constructor Description MapRegisterCacheKeyBuilder()
Construct an empty builder.MapRegisterCacheKeyBuilder(MapRegisterCacheKey base)
Construct a builder initialized with state from specifiedMapRegisterCacheKey
.
-
Method Summary
All Methods Instance Methods Concrete Methods 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(java.lang.Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MapRegisterCacheKey
build()
A newMapRegisterCacheKey
instance.byte[]
getEidPrefix()
Return current value associated with the property corresponding toMapRegisterCacheKey.getEidPrefix()
.byte[]
getSiteId()
Return current value associated with the property corresponding toMapRegisterCacheKey.getSiteId()
.byte[]
getXtrId()
Return current value associated with the property corresponding toMapRegisterCacheKey.getXtrId()
.MapRegisterCacheKeyBuilder
removeAugmentation(java.lang.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 toMapRegisterCacheKey.getEidPrefix()
to the specified value.MapRegisterCacheKeyBuilder
setSiteId(byte[] value)
Set the property corresponding toMapRegisterCacheKey.getSiteId()
to the specified value.MapRegisterCacheKeyBuilder
setXtrId(byte[] value)
Set the property corresponding toMapRegisterCacheKey.getXtrId()
to the specified value.
-
-
-
Constructor Detail
-
MapRegisterCacheKeyBuilder
public MapRegisterCacheKeyBuilder()
Construct an empty builder.
-
MapRegisterCacheKeyBuilder
public MapRegisterCacheKeyBuilder(MapRegisterCacheKey base)
Construct a builder initialized with state from specifiedMapRegisterCacheKey
.- Parameters:
base
- MapRegisterCacheKey from which the builder should be initialized
-
-
Method Detail
-
getEidPrefix
public byte[] getEidPrefix()
Return current value associated with the property corresponding toMapRegisterCacheKey.getEidPrefix()
.- Returns:
- current value
-
getSiteId
public byte[] getSiteId()
Return current value associated with the property corresponding toMapRegisterCacheKey.getSiteId()
.- Returns:
- current value
-
getXtrId
public byte[] getXtrId()
Return current value associated with the property corresponding toMapRegisterCacheKey.getXtrId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey>> E$$ augmentation(java.lang.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:
java.lang.NullPointerException
- ifaugmentType
isnull
-
setEidPrefix
public MapRegisterCacheKeyBuilder setEidPrefix(byte[] value)
Set the property corresponding toMapRegisterCacheKey.getEidPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSiteId
public MapRegisterCacheKeyBuilder setSiteId(byte[] value)
Set the property corresponding toMapRegisterCacheKey.getSiteId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setXtrId
public MapRegisterCacheKeyBuilder setXtrId(byte[] value)
Set the property corresponding toMapRegisterCacheKey.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:
java.lang.NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MapRegisterCacheKeyBuilder removeAugmentation(java.lang.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 newMapRegisterCacheKey
instance.- Returns:
- A new
MapRegisterCacheKey
instance.
-
-