-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTimerLogger.java
More file actions
executable file
·364 lines (329 loc) · 9.26 KB
/
TimerLogger.java
File metadata and controls
executable file
·364 lines (329 loc) · 9.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
package devinfalgoust.util.timerlogger;
import java.io.PrintStream;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
/**
* The TimerLogger class is designed to make logging fast and easy.
*
* @author Devin Falgoust
*
* Copyright 2013 Devin Falgoust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
public class TimerLogger {
/******************************
* ----------------------------
* Logger Use Examples
* ----------------------------
* logger.start("TimerName");
* logger.end("TimerName");
* logger.log("Message");
* logger.logError("Message");
* ----------------------------
******************************/
// Only tabify when tabifyFlag is set
private Boolean tabifyFlag;
// Printstream used for normal output
private PrintStream out;
// Printstream used for error output
private PrintStream err;
// Map to hold the timers and give them names
private Map<String, Timer> timers;
// Number of tabs to place in tabify
private Integer numTabs;
/******************************
* Logging Functions
******************************/
/**
* Start: Starts a timer with the given name attached and
* logs that it was started
* -
* This function returns a Logger so that commands can be stacked
*
* @param timerName
* - Name of Timer
* @return Logger - useful for stacking calls
*/
public TimerLogger start(String timerName) {
timers.put(timerName, new Timer());
timers.get(timerName).start();
out.println(tabify() + timerName + " - Started ... ");
numTabs++;
return this;
}
/**
* Start: Starts a timer with the given name attached and
* logs that it was started. The timer's name will be taken using the
* Object passed in's toString() function.
* -
* This function returns a Logger so that commands can be stacked
*
* @param getTimerNameFrom
* - Object Used to Get Name of Timer
* @return Logger - useful for stacking calls
*/
public TimerLogger start(Object getTimerNameFrom) {
return start(getTimerNameFrom.toString());
}
/**
* End: Ends a timer with the given name attached and logs
* that it is done. If there is no timer with the given name,
* it will log an error.
* -
* This function returns a Logger so that commands can be stacked
*
* @param timerName
* - Name of Timer
* @return Logger - useful for stacking calls
*/
public TimerLogger end(String timerName) {
try {
Long time = timers.get(timerName).end();
timers.remove(timerName);
numTabs--;
out.println(tabify() + timerName + String.format(" - Done - %d (ms)", time));
} catch (NullPointerException e) {
logError("Sorry, \"" + timerName + "\" was never started.");
// Sleep for 1ms. This ensure that the error is printed in order
// and not later on down the road
try {
Thread.sleep(1);
} catch (InterruptedException ex) {
Thread.currentThread().interrupt();
}
}
return this;
}
/**
* End: Ends a timer with the given name attached and logs
* that it is done. The timer's name will be taken using the
* Object passed in's toString() function.
* -
* This function returns a Logger so that commands can be stacked
*
* @param getTimerNameFrom
* - Object Used to Get Name of Timer
* @return Logger - useful for stacking calls
*/
public TimerLogger end(Object getTimerNameFrom) {
return end(getTimerNameFrom.toString());
}
/**
* Logs a given message on the out stream
* -
* This function returns a Logger so that commands can be stacked
*
* @param logMessage
* - Message to Log
* @return Logger - useful for stacking calls
*/
public TimerLogger log(String logMessage) {
out.println(tabify() + "-- " + logMessage);
return this;
}
/**
* Logs a given error message on the err stream
* -
* This function returns a Logger so that commands can be stacked
*
* @param errorMessage
* - Error Message to Log
* @return Logger - useful for stacking calls
*/
public TimerLogger logError(String errorMessage) {
err.println(tabify() + "-- " + errorMessage);
return this;
}
/******************************
* Constructors
******************************/
/**
* Default Constructor: Init with System.out, System.err, and
* isTabify as true
*/
public TimerLogger() {
tabifyFlag = true;
out = System.out;
err = System.err;
timers = new HashMap<String, Timer>();
numTabs = 0;
}
/**
* Constructor: Init with a given PrintStream, setting both the
* out stream and err stream to it, and setting isTabify to true
*
* @param outAndErrStream
* - PrintStream used for both output and errors
*/
public TimerLogger(PrintStream outAndErrStream) {
tabifyFlag = true;
out = err = outAndErrStream;
timers = new HashMap<String, Timer>();
numTabs = 0;
}
/**
* Constructor: Init with two PrintStreams, the first out and
* the second err, setting isTabify to true
*
* @param outStream
* - PrintStream used for output
* @param errStream
* - PrinStream used for errors
*/
public TimerLogger(PrintStream outStream, PrintStream errStream) {
tabifyFlag = true;
out = outStream;
err = errStream;
timers = new HashMap<String, Timer>();
numTabs = 0;
}
/**
* Constructor: Init with a given tabify, System.out, & System.err
*
* @param isTabify
* - Boolean for whether to tabify or not
*/
public TimerLogger(Boolean isTabify) {
tabifyFlag = isTabify;
out = System.out;
err = System.err;
timers = new HashMap<String, Timer>();
numTabs = 0;
}
/**
* Constructor: Init with a given tabify and a given PrintStream,
* setting both the out stream and err stream to it
*
* @param outAndErrStream
* - PrintStream used for both output and errors
* @param isTabify
* - Boolean for whether to tabify or not
*/
public TimerLogger(PrintStream outAndErrStream, Boolean isTabify) {
tabifyFlag = isTabify;
isTabify = true;
out = err = outAndErrStream;
timers = new HashMap<String, Timer>();
numTabs = 0;
}
/**
* Constructor: Init with a given tabify and two PrintStreams,
* the first out and the second err
*
* @param outStream
* - PrintStream used for output
* @param errStream
* - PrinStream used for errors
* @param isTabify
* - Boolean for whether to tabify or not
*/
public TimerLogger(PrintStream outStream, PrintStream errStream, Boolean isTabify) {
tabifyFlag = isTabify;
isTabify = true;
out = outStream;
err = errStream;
timers = new HashMap<String, Timer>();
numTabs = 0;
}
/**
* Basic Copy Constructor
*
* @param other
* - Other Logger to Copy
*/
public TimerLogger(TimerLogger other) {
tabifyFlag = other.tabifyFlag;
out = other.out;
err = other.err;
timers = other.timers;
numTabs = other.numTabs;
}
/******************************
* Getters and Setters
******************************/
/**
* Get the value of isTabify
*
* @return Boolean
*/
public Boolean isTabify() {
return tabifyFlag;
}
/**
* Set isTabify to true or false
*
* @param isTabify
*/
public void setTabifyFlag(Boolean isTabify) {
tabifyFlag = isTabify;
}
/**
* Set the PrintStream used for standard output
*
* @param out
*/
public void setOutPrintStream(PrintStream out) {
this.out = out;
}
/**
* Set the PrintStream used for standard error output
*
* @param err
*/
public void setErrPrintStream(PrintStream err) {
this.err = err;
}
/**
* Set the PrintStreams used for standard output and standard error output
*
* @param stream
*/
public void setOutAndErrPrintStreams(PrintStream stream) {
out = stream;
err = stream;
}
/******************************
* Helpers
******************************/
/**
* Returns a string of tabs, based upon logger hierarchy
*
* @return String - Tabs Used to Show Hierarchy
*/
private String tabify() {
String tabs = "";
// Only adds tabs if tabifyFlag is set
for (int i = 0; tabifyFlag && i < numTabs; i++) {
tabs += " ";
}
return tabs;
}
/**
* Timer class that controls start and stop functionality,
* returning a Long with time difference on stop
*/
private class Timer {
private Date startDate;
private Date endDate;
private void start() {
startDate = new Date();
}
private Long end() {
endDate = new Date();
Long time = endDate.getTime() - startDate.getTime();
return time;
}
}
}