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/Event1.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/Event1.java')
-rw-r--r-- | src/jrummikub/util/Event1.java | 40 |
1 files changed, 26 insertions, 14 deletions
diff --git a/src/jrummikub/util/Event1.java b/src/jrummikub/util/Event1.java index f0595f9..8ddf2a5 100644 --- a/src/jrummikub/util/Event1.java +++ b/src/jrummikub/util/Event1.java @@ -2,22 +2,34 @@ package jrummikub.util; import java.util.HashSet; +/** + * Simple single parameter event generator + * + * @param <T> + * type of the event parameter + */ public class Event1<T> implements IEvent1<T> { - private HashSet<IListener1<T>> listeners = new HashSet<IListener1<T>>(); + private HashSet<IListener1<T>> listeners = new HashSet<IListener1<T>>(); - @Override - public void add(IListener1<T> listener) { - listeners.add(listener); - } + @Override + public void add(IListener1<T> listener) { + listeners.add(listener); + } - @Override - public void remove(IListener1<T> listener) { - listeners.remove(listener); - } + @Override + public void remove(IListener1<T> listener) { + listeners.remove(listener); + } - public void fire(T value) { - for (IListener1<T> listener : listeners) { - listener.fire(value); - } - } + /** + * Generate a single event + * + * @param value + * the event parameter + */ + public void fire(T value) { + for (IListener1<T> listener : listeners) { + listener.fire(value); + } + } } |