content: //  Copyright 2006, Clark N. Hobbie
  //
  //  This file is part of the util library.
  //
  //  The util library is free software; you can redistribute it and/or modify it
  //  under the terms of the Lesser GNU General Public License as published by
  //  the Free Software Foundation; either version 2.1 of the License, or (at
  //  your option) any later version.
  //
  //  The util library is distributed in the hope that it will be useful, but
  //  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  //  or FITNESS FOR A PARTICULAR PURPOSE.  See the Lesser GNU General Public
  //  License for more details.
  //
  //  You should have received a copy of the Lesser GNU General Public License
  //  along with the util library; if not, write to the Free Software Foundation,
  //  Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  //
  package com.lts.scheduler;
  
  /**
   * An event to be delivered to an end-client.
   * 
   * <P>
   * An instance of this object is passed to an end-client by calling the 
   * {@link ScheduledEventListener#scheduledEvent(SchedulerEvent)} method.
   *
   * <P>
   * Instances of this class have the following properties:
   * <UL>
   * <LI>scheduledTime - when the event occurred.
   * <LI>client - an internal property
   * </UL>
   * 
   * <H3>Ascending Order</H3>
   * This class implements {@link Comparable}, but it thiks an element with 
   * an earlier scheduledTime should come before one with a later time in any 
   * comparison.
   * 
   * @author cnh
   */
  public class SchedulerEvent implements Comparable
  {
  	public long scheduledTime;
  	public Object data;
  	
  	public SchedulerEvent (long time, Object theData)
  	{
  		this.scheduledTime = time;
  		this.data = theData;
  	}
  
  	public int compareTo(Object o)
  	{
  		if (!(o instanceof SchedulerEvent))
  			throw new RuntimeException();
  		
  		SchedulerEvent other = (SchedulerEvent) o;
  		if (this.scheduledTime < other.scheduledTime)
  			return -1;
  		else if (this.scheduledTime > other.scheduledTime)
  			return 1;
  		else
  			return 0;
  	}
  	
  	public String toString()
  	{
  		return "event(" + this.scheduledTime + ")";
  	}
  	
  	public String toRelativeString(long point)
  	{
  		long delta = this.scheduledTime - point;
  		return Long.toString(delta);
  	}
  }
  