summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/esodata/AbbrevMap2.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/main/java/bjc/esodata/AbbrevMap2.java')
-rw-r--r--src/main/java/bjc/esodata/AbbrevMap2.java9
1 files changed, 8 insertions, 1 deletions
diff --git a/src/main/java/bjc/esodata/AbbrevMap2.java b/src/main/java/bjc/esodata/AbbrevMap2.java
index f79a2d2..db41471 100644
--- a/src/main/java/bjc/esodata/AbbrevMap2.java
+++ b/src/main/java/bjc/esodata/AbbrevMap2.java
@@ -3,7 +3,14 @@ package bjc.esodata;
import java.util.*;
/**
- * A revised version of {@link AbbrevMap}
+ * A map that allows you to reference strings by unambiguous abbreviations to them.
+ *
+ * One example is that adding the string 'abc' would allow you to get it back with the following three keys
+ * <ul>
+ * <li>a</li>
+ * <li>ab</li>
+ * <li>abc</li>
+ * </ul>
*
* @author Ben Culkin
*/