src/uk/ac/ntu/n0521366/wsyd/libs/net/NetworkMessageEvent.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 import java.util.EventObject;
  27
  28 /**
  29  * Custom Event for network services to notify listeners that a message has been received
  30  *
  31  * @see NetworkMessageEventGenerator
  32  * @see NetworkMessageEventListener
  33  * @author TJ <hacker@iam.tj>
  34  */
  35 public class NetworkMessageEvent extends EventObject {
  36     /**
  37      * Immutable (because it is declared final) message
  38      */
  39     private final NetworkMessage _message;
  40
  41     /**
  42      * Create a new Event.
  43      *
  44      * @param source the object firing the event
  45      * @param message the message itself
  46      */
  47     public NetworkMessageEvent(Object source, NetworkMessage message) {
  48         super(source);
  49         _message = message;
  50     }
  51
  52     /**
  53      * Retrieve the message.
  54      *
  55      * Called by event listeners.
  56      *
  57      * @return the message
  58      */
  59     public NetworkMessage getNetworkMessage() {
  60         return _message;
  61     }
  62 }