diff options
author | Jannis Harder <harder@informatik.uni-luebeck.de> | 2011-05-02 02:28:19 +0200 |
---|---|---|
committer | Jannis Harder <harder@informatik.uni-luebeck.de> | 2011-05-02 02:28:19 +0200 |
commit | 15a41ec38eaf5baca7c4266de52d1ae86ee9488b (patch) | |
tree | 30997bf36a47b95186706dc679d4a2ee379dc3b8 /src/jrummikub/util/IEvent1.java | |
parent | b89d29aac2eed38a0696eb2d81876e5c817f9327 (diff) | |
download | JRummikub-15a41ec38eaf5baca7c4266de52d1ae86ee9488b.tar JRummikub-15a41ec38eaf5baca7c4266de52d1ae86ee9488b.zip |
Documented the Event/Listener classes
git-svn-id: svn://sunsvr01.isp.uni-luebeck.de/swproj13/trunk@60 72836036-5685-4462-b002-a69064685172
Diffstat (limited to 'src/jrummikub/util/IEvent1.java')
-rw-r--r-- | src/jrummikub/util/IEvent1.java | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/src/jrummikub/util/IEvent1.java b/src/jrummikub/util/IEvent1.java index 4108078..52b9bf4 100644 --- a/src/jrummikub/util/IEvent1.java +++ b/src/jrummikub/util/IEvent1.java @@ -1,7 +1,25 @@ package jrummikub.util; +/** + * Interface for classes that can generate events having a single parameter + * + * @param <T> + * type of the event parameter + */ public interface IEvent1<T> { - public void add(IListener1<T> listener); + /** + * Start to publish all events to a given listener + * + * @param listener + * target listener + */ + public void add(IListener1<T> listener); - public void remove(IListener1<T> listener); + /** + * Stop publishing events to a given listener + * + * @param listener + * target listener + */ + public void remove(IListener1<T> listener); } |