Merge commit '7ce18848c8327967ce27b90abf2e280953530b5f'
[fanfix.git] / src / jexer / TTimer.java
1 /*
2 * Jexer - Java Text User Interface
3 *
4 * The MIT License (MIT)
5 *
6 * Copyright (C) 2019 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 class TTimer {
37
38 // ------------------------------------------------------------------------
39 // Variables --------------------------------------------------------------
40 // ------------------------------------------------------------------------
41
42 /**
43 * If true, re-schedule after every tick. Note package private access.
44 */
45 boolean recurring = false;
46
47 /**
48 * Duration (in millis) between ticks if this is a recurring timer.
49 */
50 private long duration = 0;
51
52 /**
53 * The next time this timer needs to be ticked.
54 */
55 private Date nextTick;
56
57 /**
58 * The action to perfom on a tick.
59 */
60 private TAction action;
61
62 // ------------------------------------------------------------------------
63 // Constructors -----------------------------------------------------------
64 // ------------------------------------------------------------------------
65
66 /**
67 * Package private constructor.
68 *
69 * @param duration number of milliseconds to wait between ticks
70 * @param recurring if true, re-schedule this timer after every tick
71 * @param action to perform on next tick
72 */
73 TTimer(final long duration, final boolean recurring, final TAction action) {
74
75 this.recurring = recurring;
76 this.duration = duration;
77 this.action = action;
78
79 Date now = new Date();
80 nextTick = new Date(now.getTime() + duration);
81 }
82
83 // ------------------------------------------------------------------------
84 // TTimer -----------------------------------------------------------------
85 // ------------------------------------------------------------------------
86
87 /**
88 * Get the next time this timer needs to be ticked. Note package private
89 * access.
90 *
91 * @return time at which action should be called
92 */
93 Date getNextTick() {
94 return nextTick;
95 }
96
97 /**
98 * Set the recurring flag.
99 *
100 * @param recurring if true, re-schedule this timer after every tick
101 */
102 public void setRecurring(final boolean recurring) {
103 this.recurring = recurring;
104 }
105
106 /**
107 * Tick this timer. Note package private access.
108 */
109 void tick() {
110 if (action != null) {
111 action.DO();
112 }
113 // Set next tick
114 Date ticked = new Date();
115 if (recurring) {
116 nextTick = new Date(ticked.getTime() + duration);
117 }
118 }
119
120 }