1 //******************************************************************************
2 //
3 // File: Logger.java
4 // Package: edu.rit.util
5 // Unit: Interface edu.rit.util.Logger
6 //
7 // This Java source file is copyright (C) 2008 by Alan Kaminsky. All rights
8 // reserved. For further information, contact the author, Alan Kaminsky, at
9 // ark@cs.rit.edu.
10 //
11 // This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
12 // software; you can redistribute it and/or modify it under the terms of the GNU
13 // General Public License as published by the Free Software Foundation; either
14 // version 3 of the License, or (at your option) any later version.
15 //
16 // PJ is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 // A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 //
20 // Linking this library statically or dynamically with other modules is making a
21 // combined work based on this library. Thus, the terms and conditions of the GNU
22 // General Public License cover the whole combination.
23 //
24 // As a special exception, the copyright holders of this library give you
25 // permission to link this library with independent modules to produce an
26 // executable, regardless of the license terms of these independent modules, and
27 // to copy and distribute the resulting executable under terms of your choice,
28 // provided that you also meet, for each linked independent module, the terms
29 // and conditions of the license of that module. An independent module is a module
30 // which is not derived from or based on this library. If you modify this library,
31 // you may extend this exception to your version of the library, but you are not
32 // obligated to do so. If you do not wish to do so, delete this exception
33 // statement from your version.
34 //
35 // A copy of the GNU General Public License is provided in the file gpl.txt. You
36 // may also obtain a copy of the GNU General Public License on the World Wide
37 // Web at http://www.gnu.org/licenses/gpl.html.
38 //
39 //******************************************************************************
40 package edu.rit.util;
41
42 /**
43 * Interface Logger specifies the interface for an object that logs messages.
44 *
45 * @author Alan Kaminsky
46 * @version 16-Apr-2008
47 */
48 public interface Logger {
49
50 // Exported operations.
51 /**
52 * Log the given message.
53 *
54 * @param msg Message.
55 */
56 public void log(String msg);
57
58 /**
59 * Log the given exception.
60 *
61 * @param exc Exception.
62 */
63 public void log(Throwable exc);
64
65 /**
66 * Log the given message and exception.
67 *
68 * @param msg Message.
69 * @param exc Exception.
70 */
71 public void log(String msg,
72 Throwable exc);
73
74 /**
75 * Log the given date and message.
76 *
77 * @param date Date and time in milliseconds since midnight 01-Jan-1970 UTC.
78 * @param msg Message.
79 */
80 public void log(long date,
81 String msg);
82
83 /**
84 * Log the given date and exception.
85 *
86 * @param date Date and time in milliseconds since midnight 01-Jan-1970 UTC.
87 * @param exc Exception.
88 */
89 public void log(long date,
90 Throwable exc);
91
92 /**
93 * Log the given date, message, and exception.
94 *
95 * @param date Date and time in milliseconds since midnight 01-Jan-1970 UTC.
96 * @param msg Message.
97 * @param exc Exception.
98 */
99 public void log(long date,
100 String msg,
101 Throwable exc);
102
103 }