Factor out {SharedSingleton,ImmutableOffset}MapTemplate

[yangtools.git] / common / util / src / main / java / org / opendaylight / yangtools / util / SharedSingletonMap.java

diff --git a/common/util/src/main/java/org/opendaylight/yangtools/util/SharedSingletonMap.java b/common/util/src/main/java/org/opendaylight/yangtools/util/SharedSingletonMap.java
index 0ea88bc77238a37150453987b62d28236e87748f..0dd661481e45bbea559983e15a9c3c2cd5f7f8d6 100644 (file)
--- a/common/util/src/main/java/org/opendaylight/yangtools/util/SharedSingletonMap.java
+++ b/common/util/src/main/java/org/opendaylight/yangtools/util/SharedSingletonMap.java
@@ -24,6 +24,10 @@ import org.eclipse.jdt.annotation.NonNull;
  * Implementation of the {@link Map} interface which stores a single mapping. The key set is shared among all instances
  * which contain the same key. This implementation does not support null keys or values.
  *
+ * <p>
+ * In case the set of keys is statically known, you can use {@link SharedSingletonMapTemplate} to efficiently create
+ * {@link SharedSingletonMap} instances.
+ *
  * @param <K> the type of keys maintained by this map
  * @param <V> the type of mapped values
  */