src/core/net/sf/basedb/util/bfs/EventType.java

Code
Comments
Other
Rev Date Author Line
5193 27 Nov 09 nicklas 1 /**
5193 27 Nov 09 nicklas 2   $Id$
5193 27 Nov 09 nicklas 3
5193 27 Nov 09 nicklas 4   Copyright (C) 2009 Nicklas Nordborg
5193 27 Nov 09 nicklas 5
5193 27 Nov 09 nicklas 6   This file is part of BASE - BioArray Software Environment.
5193 27 Nov 09 nicklas 7   Available at http://base.thep.lu.se/
5193 27 Nov 09 nicklas 8
5193 27 Nov 09 nicklas 9   BASE is free software; you can redistribute it and/or
5193 27 Nov 09 nicklas 10   modify it under the terms of the GNU General Public License
5193 27 Nov 09 nicklas 11   as published by the Free Software Foundation; either version 3
5193 27 Nov 09 nicklas 12   of the License, or (at your option) any later version.
5193 27 Nov 09 nicklas 13
5193 27 Nov 09 nicklas 14   BASE is distributed in the hope that it will be useful,
5193 27 Nov 09 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
5193 27 Nov 09 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5193 27 Nov 09 nicklas 17   GNU General Public License for more details.
5193 27 Nov 09 nicklas 18
5193 27 Nov 09 nicklas 19   You should have received a copy of the GNU General Public License
5193 27 Nov 09 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
5193 27 Nov 09 nicklas 21 */
5193 27 Nov 09 nicklas 22 package net.sf.basedb.util.bfs;
5193 27 Nov 09 nicklas 23
5193 27 Nov 09 nicklas 24 /**
5193 27 Nov 09 nicklas 25   Defines an event type that is sent in event notifications to event
5193 27 Nov 09 nicklas 26   handlers. The parser that defines the event type is recommended to
5193 27 Nov 09 nicklas 27   keep a <code>public static final EventType ...</code> constant for
5193 27 Nov 09 nicklas 28   each event type it defines. Event handlers can then simply reference
5193 27 Nov 09 nicklas 29   this constant to determine which event that was fired. Eg.
5193 27 Nov 09 nicklas 30   <pre>
5193 27 Nov 09 nicklas 31 public void handleEvent(EventType eventType, Object eventData)
5193 27 Nov 09 nicklas 32 {
5193 27 Nov 09 nicklas 33   if (eventType == Parser.PRE_DEFINED_TYPE_1)
5193 27 Nov 09 nicklas 34   {
5193 27 Nov 09 nicklas 35      // Do something
5193 27 Nov 09 nicklas 36   }
5193 27 Nov 09 nicklas 37   else if (eventType == Parser.PRE_DEFINED_TYPE_2)
5193 27 Nov 09 nicklas 38   {
5193 27 Nov 09 nicklas 39     // Do something else
5193 27 Nov 09 nicklas 40   }
5193 27 Nov 09 nicklas 41 }
5193 27 Nov 09 nicklas 42 </pre>
5193 27 Nov 09 nicklas 43   
5193 27 Nov 09 nicklas 44   @author Nicklas
5193 27 Nov 09 nicklas 45   @version 2.15
5193 27 Nov 09 nicklas 46   @base.modified $Date$
5193 27 Nov 09 nicklas 47   @see EventHandler
5193 27 Nov 09 nicklas 48 */
5193 27 Nov 09 nicklas 49 public class EventType<T>
5193 27 Nov 09 nicklas 50 {
5193 27 Nov 09 nicklas 51   
5193 27 Nov 09 nicklas 52   private final String id;
5193 27 Nov 09 nicklas 53
5193 27 Nov 09 nicklas 54   /**
5193 27 Nov 09 nicklas 55     Create a new event type object.
5193 27 Nov 09 nicklas 56   */
5193 27 Nov 09 nicklas 57   public EventType(String id)
5193 27 Nov 09 nicklas 58   {
5193 27 Nov 09 nicklas 59     this.id = id;
5193 27 Nov 09 nicklas 60   }
5193 27 Nov 09 nicklas 61   
5193 27 Nov 09 nicklas 62   @Override
5193 27 Nov 09 nicklas 63   public String toString()
5193 27 Nov 09 nicklas 64   {
5193 27 Nov 09 nicklas 65     return "EventType(" + id + ")";
5193 27 Nov 09 nicklas 66   }
5193 27 Nov 09 nicklas 67   
5193 27 Nov 09 nicklas 68 }

Generated on Sat Oct  7 02:36:10 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)