OSDN Git Service

tc
[chemicraft/chemicraft.git] / common / pcc / chemicraft / util / ListHash.java
index 9040d1f..04f9fb1 100644 (file)
@@ -9,11 +9,31 @@ import java.util.ListIterator;
 import java.util.Map;
 import java.util.Set;
 
+/**
+ * ListHashは型Kに対応したArrayListに型Eを追加する機能を提供します。<br>
+ *
+ * このクラスを作成すると、まず<br>
+ * <pre>
+ * HashMap&lt;K, ArrayList&lt;E&gt;&gt;
+ * </pre>
+ * が生成されます。<br>
+ * 型KはHashMapやTreeMapを使った時とように使用します。<br>
+ * 型EはArrayListの型を指定します。<br>
+ * <br>
+ * <h2>構造解説:</h2>
+ * HashMapの型VがArrayListになっており、ArrayListの型Eがこのクラスの型Eになります。<br>
+ * HashMapでは型Vを値として入れなければいけませんが、ListHashではこのクラスの型EをArrayListに入れることができます。<br>
+ *
+ * @author mozipi
+ *
+ * @param <K> Key
+ * @param <E> Element
+ */
 public class ListHash<K, E>
 {
    /**
     * @author Ponkotate version:1.0.0 dev
-    * 
+    *
     *         Create ArrayList in HashMap.
     */