summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/everge/LogStream.java
blob: 68bbf84afdac6eae5cfde623ff540997527f3d1d (plain)
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
package bjc.everge;

import java.io.*;

/**
 * Simple class used for logging with various levels.
 *
 * @author Ben Culkin
 */
public class LogStream {
	/**
	 * Log level for printing nothing.
	 */
	public static final int NOTHING = -1;

	/**
	 * Log level for printing only fatal errors.
	 */
	public static final int FATAL = 0;

	/**
	 * Log level for printing all errors.
	 */
	public static final int ERROR = 1;

	/**
	 * Log level for printing warnings.
	 */
	public static final int WARN = 2;

	/**
	 * Log level for printing info messages.
	 */
	public static final int INFO = 3;

	/**
	 * Log level for printing debug messages.
	 */
	public static final int DEBUG = 4;

	/**
	 * Log level for printing trace messages.
	 */
	public static final int TRACE = 5;

	private int verbosity;

	private PrintStream output;

	/**
	 * Create a new log stream.
	 *
	 * Defaults to printing only fatal errors.
	 *
	 * @param out
	 *            The output stream to place things into.
	 */
	public LogStream(PrintStream out) {
		output = out;
		verbosity = FATAL;
	}

	/**
	 * Create a new log stream.
	 *
	 * @param out
	 *              The output stream to place things into.
	 * @param level
	 *              The verbosity level. Use the constants in this class for the
	 *              values.
	 */
	public LogStream(PrintStream out, int level) {
		output = out;
		verbosity = level;
	}

	/**
	 * Get the verbosity of the stream.
	 * 
	 * @return The verbosity of the stream.
	 */
	public int verbosity() {
		return verbosity;
	}

	/**
	 * Set the verbosity of the stream.
	 * 
	 * @param verb
	 *             The verbosity of the stream.
	 */
	public void verbosity(int verb) {
		verbosity = verb;
	}

	/**
	 * Increment the verbosity of the stream.
	 */
	public void louder() {
		louder(1);
	}

	/**
	 * Increase the verbosity of the stream by an amount.
	 * 
	 * @param amt
	 *            The amount to increase the verbosity by.
	 */
	public void louder(int amt) {
		verbosity += amt;
	}

	/**
	 * Decrement the verbosity of the stream.
	 */
	public void quieter() {
		quieter(1);
	}

	/**
	 * Decrease the verbosity of the stream by an amount.
	 * 
	 * @param amt
	 *            The amount to decrease the verbosity by.
	 */
	public void quieter(int amt) {
		verbosity -= amt;
	}

	/**
	 * Print a message that will always be visible.
	 *
	 * @param msg
	 *            The message to print.
	 */
	public void print(String msg) {
		output.print(msg);
	}

	/**
	 * Print a formatted message that will always be visible.
	 *
	 * @param msg
	 *             The format string for the message to print.
	 *
	 * @param args
	 *             The arguments to the format string.
	 */
	public void printf(String msg, Object... args) {
		output.printf(msg, args);
	}

	/**
	 * Print a message at a given verbosity level.
	 * 
	 * @param lvl
	 *            The verbosity level.
	 * @param msg
	 *            The message to print.
	 */
	public void message(int lvl, String msg) {
		if (verbosity >= lvl) {
			output.print(msg);
		}
	}

	public void messagef(int lvl, String msg, Object... args) {
		if (verbosity >= lvl) {
			output.printf(msg, args);
		}
	}

	public void fatal(String msg) {
		message(FATAL, msg);
	}

	public void fatalf(String msg, Object... args) {
		messagef(FATAL, msg, args);
	}

	public void error(String msg) {
		message(ERROR, msg);
	}

	public void errorf(String msg, Object... args) {
		messagef(ERROR, msg, args);
	}

	public void warn(String msg) {
		message(WARN, msg);
	}

	public void warnf(String msg, Object... args) {
		messagef(WARN, msg, args);
	}

	public void info(String msg) {
		message(INFO, msg);
	}

	public void infof(String msg, Object... args) {
		messagef(INFO, msg, args);
	}

	public void debug(String msg) {
		message(DEBUG, msg);
	}

	public void debugf(String msg, Object... args) {
		messagef(DEBUG, msg, args);
	}

	public void trace(String msg) {
		message(TRACE, msg);
	}

	public void tracef(String msg, Object... args) {
		messagef(TRACE, msg, args);
	}
}