Class MapRegisterCacheKeyBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.key.container.MapRegisterCacheKeyBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MapRegisterCacheKey>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MapRegisterCacheKey,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MapRegisterCacheKeyBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MapRegisterCacheKey>
Class that buildsMapRegisterCacheKeyBuilder
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:
MapRegisterCacheKeyBuilder createTarget(int fooXyzzy, int barBaz) { return new MapRegisterCacheKeyBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MapRegisterCacheKeyBuilder, 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 oportunities, 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:
MapRegisterCacheKeyBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MapRegisterCacheKeyBuilder()
MapRegisterCacheKeyBuilder(MapRegisterCacheKey base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MapRegisterCacheKeyBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
MapRegisterCacheKey
build()
byte[]
getEidPrefix()
byte[]
getSiteId()
byte[]
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)
MapRegisterCacheKeyBuilder
setSiteId(byte[] value)
MapRegisterCacheKeyBuilder
setXtrId(byte[] value)
-
-
-
Constructor Detail
-
MapRegisterCacheKeyBuilder
public MapRegisterCacheKeyBuilder()
-
MapRegisterCacheKeyBuilder
public MapRegisterCacheKeyBuilder(MapRegisterCacheKey base)
-
-
Method Detail
-
getEidPrefix
public byte[] getEidPrefix()
-
getSiteId
public byte[] getSiteId()
-
getXtrId
public byte[] getXtrId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEidPrefix
public MapRegisterCacheKeyBuilder setEidPrefix(byte[] value)
-
setSiteId
public MapRegisterCacheKeyBuilder setSiteId(byte[] value)
-
setXtrId
public MapRegisterCacheKeyBuilder setXtrId(byte[] value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public MapRegisterCacheKeyBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheKey> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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 MapRegisterCacheKey build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MapRegisterCacheKey>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MapRegisterCacheKey,java.lang.IllegalArgumentException>
-
-