Documented the Event/Listener classes

git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@60 72836036-5685-4462-b002-a69064685172

1 files changed, 30 insertions, 14 deletions

diff --git a/src/jrummikub/util/Event2.java b/src/jrummikub/util/Event2.java
index c7ca8e7..f89446e 100644
--- a/src/jrummikub/util/Event2.java
+++ b/src/jrummikub/util/Event2.java
@@ -2,22 +2,38 @@ package jrummikub.util;
 
 import java.util.HashSet;
 
+/**
+ * Simple single parameter event generator
+ * 
+ * @param <T1>
+ *            type of the first event parameter
+ * @param <T2>
+ *            type of the second event parameter
+ */
 public class Event2<T1, T2> implements IEvent2<T1, T2> {
-  private HashSet<IListener2<T1, T2>> listeners = new HashSet<IListener2<T1, T2>>();
+	private HashSet<IListener2<T1, T2>> listeners = new HashSet<IListener2<T1, T2>>();
 
-  @Override
-  public void add(IListener2<T1, T2> listener) {
-    listeners.add(listener);
-  }
+	@Override
+	public void add(IListener2<T1, T2> listener) {
+		listeners.add(listener);
+	}
 
-  @Override
-  public void remove(IListener2<T1, T2> listener) {
-    listeners.remove(listener);
-  }
+	@Override
+	public void remove(IListener2<T1, T2> listener) {
+		listeners.remove(listener);
+	}
 
-  public void fire(T1 value1, T2 value2) {
-    for (IListener2<T1, T2> listener : listeners) {
-      listener.fire(value1, value2);
-    }
-  }
+	/**
+	 * Generate a single event
+	 * 
+	 * @param value1
+	 *            the first event parameter
+	 * @param value2
+	 *            the second event parameter
+	 */
+	public void fire(T1 value1, T2 value2) {
+		for (IListener2<T1, T2> listener : listeners) {
+			listener.fire(value1, value2);
+		}
+	}
 }