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

   1 /*
   2  * The MIT License
   3  *
   4  * Copyright 2015 TJ <hacker@iam.tj>.
   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 /**
  27  * Implemented by classes that generate NetworkMessageEvent events.
  28  *
  29  * @see NetworkMessage
  30  * @see NetworkMessageEvent
  31  * @see NetworkMessageEventListener
  32  * @see NetworkMessageEventListenerManager
  33  * @author TJ <hacker@iam.tj>
  34  */
  35 public interface NetworkMessageEventGenerator {
  36     /**
  37      * Adds a listener to the list.
  38      *
  39      * @param listener
  40      */
  41     public void addNetworkMessageEventListener(NetworkMessageEventListener listener);
  42     /**
  43      * Adds a filtered listener to the list.
  44      *
  45      * This listener will only receive events for NetworkMessages that have a matching intent.
  46      *
  47      * @param listener
  48      * @param intent the intent to match
  49      */
  50     public void addNetworkMessageEventListener(NetworkMessageEventListener listener, String intent);
  51
  52     /**
  53      * Removes a listener from the list.
  54      *
  55      * @param listener
  56      */
  57     public void removeNetworkMessageEventListener(NetworkMessageEventListener listener);
  58
  59     /**
  60      * Sends message to all registered listeners.
  61      *
  62      * @param message
  63      */
  64     public void fireNetworkMessageEvent(NetworkMessage message);
  65 }