Class MapRegisterCacheMetadataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.map.register.cache.metadata.container.MapRegisterCacheMetadataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MapRegisterCacheMetadata>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MapRegisterCacheMetadata,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MapRegisterCacheMetadataBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MapRegisterCacheMetadata>
Class that buildsMapRegisterCacheMetadataBuilder
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:
MapRegisterCacheMetadataBuilder createTarget(int fooXyzzy, int barBaz) { return new MapRegisterCacheMetadataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MapRegisterCacheMetadataBuilder, 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:
MapRegisterCacheMetadataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MapRegisterCacheMetadataBuilder()
MapRegisterCacheMetadataBuilder(MapRegisterCacheMetadata base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MapRegisterCacheMetadataBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MapRegisterCacheMetadataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MapRegisterCacheMetadata
build()
java.util.Map<EidLispAddressKey,EidLispAddress>
getEidLispAddress()
SiteId
getSiteId()
java.lang.Long
getTimestamp()
XtrId
getXtrId()
java.lang.Boolean
isMergeEnabled()
java.lang.Boolean
isWantMapNotify()
MapRegisterCacheMetadataBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata>> augmentationType)
Remove an augmentation from this builder's product.MapRegisterCacheMetadataBuilder
setEidLispAddress(java.util.List<EidLispAddress> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEidLispAddress(Map)
instead.MapRegisterCacheMetadataBuilder
setEidLispAddress(java.util.Map<EidLispAddressKey,EidLispAddress> values)
MapRegisterCacheMetadataBuilder
setMergeEnabled(java.lang.Boolean value)
MapRegisterCacheMetadataBuilder
setSiteId(SiteId value)
MapRegisterCacheMetadataBuilder
setTimestamp(java.lang.Long value)
MapRegisterCacheMetadataBuilder
setWantMapNotify(java.lang.Boolean value)
MapRegisterCacheMetadataBuilder
setXtrId(XtrId value)
-
-
-
Constructor Detail
-
MapRegisterCacheMetadataBuilder
public MapRegisterCacheMetadataBuilder()
-
MapRegisterCacheMetadataBuilder
public MapRegisterCacheMetadataBuilder(MapRegisterCacheMetadata base)
-
-
Method Detail
-
getEidLispAddress
public java.util.Map<EidLispAddressKey,EidLispAddress> getEidLispAddress()
-
getSiteId
public SiteId getSiteId()
-
getTimestamp
public java.lang.Long getTimestamp()
-
getXtrId
public XtrId getXtrId()
-
isMergeEnabled
public java.lang.Boolean isMergeEnabled()
-
isWantMapNotify
public java.lang.Boolean isWantMapNotify()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setEidLispAddress
public MapRegisterCacheMetadataBuilder setEidLispAddress(java.util.Map<EidLispAddressKey,EidLispAddress> values)
-
setEidLispAddress
@Deprecated(forRemoval=true) public MapRegisterCacheMetadataBuilder setEidLispAddress(java.util.List<EidLispAddress> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetEidLispAddress(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
setSiteId
public MapRegisterCacheMetadataBuilder setSiteId(SiteId value)
-
setTimestamp
public MapRegisterCacheMetadataBuilder setTimestamp(java.lang.Long value)
-
setXtrId
public MapRegisterCacheMetadataBuilder setXtrId(XtrId value)
-
setMergeEnabled
public MapRegisterCacheMetadataBuilder setMergeEnabled(java.lang.Boolean value)
-
setWantMapNotify
public MapRegisterCacheMetadataBuilder setWantMapNotify(java.lang.Boolean value)
-
addAugmentation
public MapRegisterCacheMetadataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata> 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 MapRegisterCacheMetadataBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata> 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 MapRegisterCacheMetadataBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MapRegisterCacheMetadata>> 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 MapRegisterCacheMetadata build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MapRegisterCacheMetadata>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MapRegisterCacheMetadata,java.lang.IllegalArgumentException>
-
-