Documentation

schemacrawler · Feb 8, 2018 · 2f9d344 · 2f9d344
1 parent 603cbb5
commit 2f9d344
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/schemacrawler-api/src/main/java/schemacrawler/crawl/NamedObjectList.java b/schemacrawler-api/src/main/java/schemacrawler/crawl/NamedObjectList.java
@@ -49,8 +49,10 @@
 
 /**
  * Ordered list of named objects, that can be searched associatively.
- *
- * @author Sualeh Fatehi
+ * NamedObjectList has the ability to look up by dependent object which
+ * is not created yet. That is, by NamedObject + String. Returns values
+ * sorted in natural sort order, and is iterable. The iterator does not
+ * allow modifications to the underlying data structure.
  */
 final class NamedObjectList<N extends NamedObject>
   implements Serializable, ReducibleCollection<N>