1 /*
2 * This file is part of AceLogger.
3 *
4 * AceLogger is free software: you can redistribute it and/or modify it under the terms of the GNU
5 * Lesser General Public License as published by the Free Software Foundation, either version 3 of
6 * the License, or (at your option) any later version.
7 *
8 * AceLogger is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
9 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 * Lesser General Public License for more details.
11 *
12 * You should have received a copy of the GNU Lesser General Public License along with AceLogger.
13 * If not, see <http://www.gnu.org/licenses/lgpl-3.0.html>.
14 */
15 package net.sourceforge.acelogger.level;
16
17 /**
18 * A logging level enumeration describing each supported level and it's intended use.
19 *
20 * @author Zardi (https://sourceforge.net/users/daniel_zardi)
21 * @version 1.0.0
22 * @since 1.0.0
23 */
24 public enum LogLevel {
25
26 /**
27 * A log level used to "echo" the application state, most of the times this level should be
28 * disabled in production as it generates large amount of data, and sometimes this data should
29 * not be stored for security reasons.
30 *
31 * @since 1.0.0
32 */
33 TRACE,
34
35 /**
36 * A log level used to trace an application decisions and results, information in this .level
37 * should be enough to determine the path used to obtain the results.
38 *
39 * @since 1.0.0
40 */
41 DEBUG,
42
43 /**
44 * A log level used to inform an expected (but undesired) condition, like a failed security
45 * check for an user.
46 *
47 * @since 1.0.0
48 */
49 INFO,
50
51 /**
52 * A log level used to indicate an occurrence of an uncommon (but somehow expected) condition,
53 * like not having a value were expected.
54 *
55 * @since 1.0.0
56 */
57 WARN,
58
59 /**
60 * A log level used to indicate a recoverable error, like a connection loss or an inexistent
61 * file.
62 *
63 * @since 1.0.0
64 */
65 ERROR,
66
67 /**
68 * A log level used to indicate an unrecoverable error, most of the times the program will not
69 * continue running after a fatal exception, and if it continues running we can't guarantee the
70 * results, like an out of memory error.
71 *
72 * @since 1.0.0
73 */
74 FATAL
75
76 }