01: package org.swingml.system;
02:
03: /**
04: * @author CrossLogic
05: */
06: public interface ILogCapable {
07:
08: // Severity levels
09: public final static int DEBUG = 1;
10: public final static int ERROR = 4;
11: public final static int FATAL = 5;
12: public final static int INFO = 2;
13: public final static int TRIVIAL = 0;
14: public final static int WARN = 3;
15:
16: /**
17: * Turns all levels of logging off.
18: *
19: */
20: public void end();
21:
22: /**
23: * Logs the given messague using default logging level, then turns all levels of logging off.
24: *
25: */
26: public void end(String message);
27:
28: /**
29: * Returns the default severity level to use if none (or invalid) is specified in a log call.
30: *
31: * @return
32: */
33: public int getDefaultLevel();
34:
35: /**
36: * Returns True if the system is currently turned on.
37: *
38: * @return
39: */
40: public boolean isStarted();
41:
42: /**
43: * Log the given object using the given severity level. If the severity level is invalid, the default is used.
44: *
45: * @param severityLevel
46: * @param anObject
47: */
48: public void log(int severityLevel, Object anObject);
49:
50: /**
51: * Log the given message using the given severity level. If the severity level is invalid, the default is used.
52: *
53: * @param severityLevel
54: * @param anObject
55: */
56: public void log(int severityLevel, String message);
57:
58: /**
59: * Log the given object using the default severity level.
60: *
61: * @param severityLevel
62: * @param anObject
63: */
64: public void log(Object anObject);
65:
66: /**
67: * Log the given message using the default severity level.
68: *
69: * @param severityLevel
70: * @param anObject
71: */
72: public void log(String message);
73:
74: /**
75: * Set the default severity level to be used when a severity level is unspecified, or invalid.
76: *
77: * @param severityLevel
78: */
79: public void setDefaultLevel(int severityLevel);
80:
81: /**
82: * Turns on logging.
83: *
84: */
85: public void start();
86:
87: /**
88: * Turns on logging, then logs the given message using default logging level.
89: *
90: * @param message
91: */
92: public void start(String message);
93:
94: }
|