net.happybrackets.core.scheduling

Class ScheduledObject

java.lang.Object

net.happybrackets.core.scheduling.ScheduledObject

All Implemented Interfaces:

java.lang.Comparable

public class ScheduledObject
extends java.lang.Object
implements java.lang.Comparable

Comparator

Constructor Summary

Constructors

Constructor and Description
ScheduledObject(double time, java.lang.Object object, ScheduledEventListener listener) Constructor for a comparable scheduled object

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object o)
ScheduledEventListener	getScheduledEventListener() A listener that can be called from this scheduled object
java.lang.Object	getScheduledObject() The object that is scheduled
double	getScheduledTime() The scheduled time for this object
boolean	isCancelled() if we have cancelled this event and it should be ignored
void	setCancelled(boolean cancelled) Whether we want to set cancellation of this object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduledObject

public ScheduledObject(double time,
                       java.lang.Object object,
                       ScheduledEventListener listener)

Constructor for a comparable scheduled object

Parameters:

time - the time it needs to be scheduled - this is what is compared

object - the object that needs to be scheduled

listener - the listener attached to this event

Method Detail

isCancelled

public boolean isCancelled()

if we have cancelled this event and it should be ignored

Returns:

whether we have cancelled set

setCancelled

public void setCancelled(boolean cancelled)

Whether we want to set cancellation of this object.

Parameters:

cancelled - whther we are cancelling this scheduled event

getScheduledTime

public double getScheduledTime()

The scheduled time for this object

Returns:

scheduled time

getScheduledObject

public java.lang.Object getScheduledObject()

The object that is scheduled

Returns:

the object stored

getScheduledEventListener

public ScheduledEventListener getScheduledEventListener()

A listener that can be called from this scheduled object

Returns:

the ScheduledObject created. We return this so they can cancel it later

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable