summaryrefslogtreecommitdiffstats
path: root/src/jrummikub/util/IEvent2.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/jrummikub/util/IEvent2.java')
-rw-r--r--src/jrummikub/util/IEvent2.java24
1 files changed, 22 insertions, 2 deletions
diff --git a/src/jrummikub/util/IEvent2.java b/src/jrummikub/util/IEvent2.java
index ac68c4f..967b65c 100644
--- a/src/jrummikub/util/IEvent2.java
+++ b/src/jrummikub/util/IEvent2.java
@@ -1,7 +1,27 @@
package jrummikub.util;
+/**
+ * Interface for classes that can generate events having a two parameters
+ *
+ * @param <T1>
+ * type of the first event parameter
+ * @param <T2>
+ * type of the second event parameter
+ */
public interface IEvent2<T1, T2> {
- public void add(IListener2<T1, T2> listener);
+ /**
+ * Start to publish all events to a given listener
+ *
+ * @param listener
+ * target listener
+ */
+ public void add(IListener2<T1, T2> listener);
- public void remove(IListener2<T1, T2> listener);
+ /**
+ * Stop publishing events to a given listener
+ *
+ * @param listener
+ * target listener
+ */
+ public void remove(IListener2<T1, T2> listener);
}