src/jexer/TTimer.java

   1 /*
   2  * Jexer - Java Text User Interface
   3  *
   4  * The MIT License (MIT)
   5  *
   6  * Copyright (C) 2016 Kevin Lamonte
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a
   9  * copy of this software and associated documentation files (the "Software"),
  10  * to deal in the Software without restriction, including without limitation
  11  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12  * and/or sell copies of the Software, and to permit persons to whom the
  13  * Software is furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  21  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24  * DEALINGS IN THE SOFTWARE.
  25  *
  26  * @author Kevin Lamonte [kevin.lamonte@gmail.com]
  27  * @version 1
  28  */
  29 package jexer;
  30
  31 import java.util.Date;
  32
  33 /**
  34  * TTimer implements a simple timer.
  35  */
  36 public final class TTimer {
  37
  38     /**
  39      * If true, re-schedule after every tick.  Note package private access.
  40      */
  41     boolean recurring = false;
  42
  43     /**
  44      * Duration (in millis) between ticks if this is a recurring timer.
  45      */
  46     private long duration = 0;
  47
  48     /**
  49      * The next time this timer needs to be ticked.
  50      */
  51     private Date nextTick;
  52
  53     /**
  54      * Get the next time this timer needs to be ticked.  Note package private
  55      * access.
  56      *
  57      * @return time at which action should be called
  58      */
  59     Date getNextTick() {
  60         return nextTick;
  61     }
  62
  63     /**
  64      * The action to perfom on a tick.
  65      */
  66     private TAction action;
  67
  68     /**
  69      * Tick this timer.  Note package private access.
  70      */
  71     void tick() {
  72         if (action != null) {
  73             action.DO();
  74         }
  75         // Set next tick
  76         Date ticked = new Date();
  77         if (recurring) {
  78             nextTick = new Date(ticked.getTime() + duration);
  79         }
  80     }
  81
  82     /**
  83      * Package private constructor.
  84      *
  85      * @param duration number of milliseconds to wait between ticks
  86      * @param recurring if true, re-schedule this timer after every tick
  87      * @param action to perform on next tick
  88      */
  89     TTimer(final long duration, final boolean recurring, final TAction action) {
  90
  91         this.recurring = recurring;
  92         this.duration  = duration;
  93         this.action    = action;
  94
  95         Date now = new Date();
  96         nextTick = new Date(now.getTime() + duration);
  97     }
  98
  99 }