src/uk/ac/ntu/n0521366/wsyd/libs/net/NetworkMessageEventListenerManager.java

   1 /*
   2  * The MIT License
   3  *
   4  * Copyright 2015 eddie.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 package uk.ac.ntu.n0521366.wsyd.libs.net;
  25
  26 import java.util.ArrayList;
  27
  28 /**
  29  *
  30  * @author eddie
  31  */
  32 public class NetworkMessageEventListenerManager implements NetworkMessageEventGenerator {
  33     /**
  34      * Wrapper allowing filtering of NetworkMessageEvents based on message intent.
  35      */
  36     public class NetworkMessageEventListenerWithIntent {
  37         String _intent;
  38         NetworkMessageEventListener _listener;
  39
  40         public NetworkMessageEventListenerWithIntent(NetworkMessageEventListener listener, String intent) {
  41             _intent = intent;
  42             _listener = listener;
  43         }
  44     }
  45     protected ArrayList<NetworkMessageEventListenerWithIntent> _NetworkMessageEventListeners;
  46
  47     /**
  48      * Construct an empty list of Event Listeners.
  49      */
  50     NetworkMessageEventListenerManager() {
  51         _NetworkMessageEventListeners = new ArrayList<>();
  52     }
  53
  54     /**
  55      * Add a NetworkMessageEvent listener.
  56      *
  57      * Listens to all intents.
  58      *
  59      * @param listener
  60      */
  61     @Override
  62     public synchronized void addNetworkMessageEventListener(NetworkMessageEventListener listener) {
  63         _NetworkMessageEventListeners.add(new NetworkMessageEventListenerWithIntent(listener, null));
  64     }
  65
  66     /**
  67      * Add a filtered NetworkMessageEvent listener.
  68      *
  69      * Filters on the intent of the NetworkMessage.
  70      *
  71      * @param listener
  72      * @param intent null to listen to all intents, otherwise the intent to listen for
  73      */
  74     @Override
  75     public synchronized void addNetworkMessageEventListener(NetworkMessageEventListener listener, String intent) {
  76         _NetworkMessageEventListeners.add(new NetworkMessageEventListenerWithIntent(listener, intent));
  77     }
  78
  79     /**
  80      * Remove a NetworkMessageEvent listener.
  81      *
  82      * @param listener
  83      */
  84     @Override
  85     public synchronized void removeNetworkMessageEventListener(NetworkMessageEventListener listener) {
  86         for (NetworkMessageEventListenerWithIntent intentListener : _NetworkMessageEventListeners)
  87             if (intentListener._listener == listener)
  88                 _NetworkMessageEventListeners.remove(intentListener);
  89     }
  90
  91     /**
  92      * Send a NetworkMessageEvent to all listeners.
  93      *
  94      * Only sends the message to listeners registered for the same intent, or for all messages.
  95      *
  96      * @param message the NetworkMessage to send
  97      */
  98     @Override
  99     public synchronized void fireNetworkMessageEvent(NetworkMessage message) {
 100         NetworkMessageEvent event = new NetworkMessageEvent(this, message);
 101         for (NetworkMessageEventListenerWithIntent intentListener : _NetworkMessageEventListeners) {
 102             if (intentListener._intent.equals(message._intent) || intentListener._intent == null)
 103                 intentListener._listener.NetworkMessageReceived(event);
 104         }
 105     }
 106 }