-
Notifications
You must be signed in to change notification settings - Fork 53
Expand file tree
/
Copy pathLogMessage.java
More file actions
139 lines (122 loc) · 4.06 KB
/
LogMessage.java
File metadata and controls
139 lines (122 loc) · 4.06 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
/*
* #%L
* SciJava Common shared library for SciJava software.
* %%
* Copyright (C) 2009 - 2026 SciJava developers.
* %%
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
* #L%
*/
package org.scijava.log;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.LinkedList;
import org.scijava.event.EventService;
/**
* A log message broadcast by a {@link Logger}.
* <p>
* NB: The message is published <em>on the calling thread</em> by
* {@link Logger#notifyListeners}, <em>not</em> on a dedicated event dispatch
* thread by the {@link EventService}. This is done to avoid the overhead of the
* event service's synchronized pub/sub implementation, as well as to avoid
* potential infinite loops caused by debugging log messages surrounding event
* publication.
* </p>
*
* @author Matthias Arzt
*/
public class LogMessage {
private final LogSource source;
private final int level;
private final String message;
private final Throwable throwable;
private final Date time;
private Collection<Object> attachments;
public LogMessage(LogSource source, int level, Object message,
Throwable throwable)
{
this.source = source;
this.attachments = null;
this.level = level;
this.message = message == null ? null : message.toString();
this.throwable = throwable;
this.time = new Date();
}
public LogMessage(LogSource source, int level, Object msg) {
this(source, level, msg, null);
}
/** Represents the source of the message. */
public LogSource source() {
return source;
}
/**
* Log level of the message.
*
* @see LogLevel
*/
public int level() {
return level;
}
/** The content of this log message. */
public String text() {
return message;
}
/** Exception associated with the log message. */
public Throwable throwable() {
return throwable;
}
/** Time of the creation of the log message. */
public Date time() {
return time;
}
/**
* Collection of objects that have been attached to this message with
* {@link #attach(Object)}.
*/
public Collection<Object> attachments() {
if (attachments == null) return Collections.emptyList();
return Collections.unmodifiableCollection(attachments);
}
/**
* Attach object to this log message. This can be used to attach additional
* information to the log message.
*/
public void attach(Object value) {
if (attachments == null) attachments = new LinkedList<>();
attachments.add(value);
}
// -- Object methods --
@Override
public String toString() {
final StringWriter sw = new StringWriter();
final PrintWriter printer = new PrintWriter(sw);
printer.print("[" + LogLevel.prefix(level()) + "] ");
if(text() != null) printer.println(text());
if (throwable() != null) {
throwable().printStackTrace(printer);
}
return sw.toString();
}
}