com.asdf.server
Class GameTimer

java.lang.Object
  extended by com.asdf.server.GameTimer

public class GameTimer
extends java.lang.Object

Timer class providing thread safe timer for Game instances.


Constructor Summary
GameTimer()
           
 
Method Summary
 void cancel()
          Cancel all current tasks.
 void schedule(GameTimerTask task, long delay)
          Schedules the specified task for execution after the specified delay.
 void schedule(GameTimerTask task, long delay, long period)
          Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GameTimer

public GameTimer()
Method Detail

schedule

public void schedule(GameTimerTask task,
                     long delay)
Schedules the specified task for execution after the specified delay.

Parameters:
task - task to be scheduled.
delay - delay in milliseconds before task is to be executed.
Throws:
java.lang.IllegalArgumentException - if delay is negative, or delay + System.currentTimeMillis() is negative.
java.lang.IllegalStateException - if task was already scheduled or cancelled, or timer was cancelled.

schedule

public void schedule(GameTimerTask task,
                     long delay,
                     long period)
Schedules the specified task for repeated fixed-delay execution, beginning after the specified delay. Subsequent executions take place at approximately regular intervals separated by the specified period.

In fixed-delay execution, each execution is scheduled relative to the actual execution time of the previous execution. If an execution is delayed for any reason (such as garbage collection or other background activity), subsequent executions will be delayed as well. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified period (assuming the system clock underlying Object.wait(long) is accurate).

Fixed-delay execution is appropriate for recurring activities that require "smoothness." In other words, it is appropriate for activities where it is more important to keep the frequency accurate in the short run than in the long run. This includes most animation tasks, such as blinking a cursor at regular intervals. It also includes tasks wherein regular activity is performed in response to human input, such as automatically repeating a character as long as a key is held down.

Parameters:
task - task to be scheduled.
delay - delay in milliseconds before task is to be executed.
period - time in milliseconds between successive task executions.
Throws:
java.lang.IllegalArgumentException - if delay is negative, or delay + System.currentTimeMillis() is negative.
java.lang.IllegalStateException - if task was already scheduled or cancelled, timer was cancelled, or timer thread terminated.

cancel

public void cancel()
Cancel all current tasks.