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
|
/*
* SonarQube :: Plugin API
* Copyright (C) 2009-2016 SonarSource SA
* mailto:contact AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonar.api.utils;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import java.util.Collection;
import java.util.Collections;
import static com.google.common.collect.Lists.newArrayList;
/**
* Runtime exception for "functional" error. It aims to be displayed to end-users, without any technical information
* like stack traces.
* <p/>
*
* It's handling depends on the versions of the sonar-batch and sonar-runner. sonar-runner 2.4 will only show the
* message associated with this exception.
* Starting from sonar-batch 5.3, this is handled in the batch side, and the main goal is to hide all wrappers of this
* exception. If this exception is created without cause, then only the message associated with this exception is shown;
* otherwise, its causes are also shown.
* Previous combinations of sonar-batch/sonar-runner log all stack trace.
* <p/>
* Message should be clear and complete. Keep in mind that context might not be added to the exception.
* Names of processed resource and decorator are for example not automatically added when throwing {@link MessageException}
* from {@link org.sonar.api.batch.Decorator}.
*
* @since 3.7.1
*/
public class MessageException extends RuntimeException {
private final String l10nKey;
private final Collection<Object> l10nParams;
private MessageException(String s) {
this(s, null, null);
}
private MessageException(@Nullable String message, @Nullable String l10nKey, @Nullable Object[] l10nParams) {
super(message);
this.l10nKey = l10nKey;
this.l10nParams = l10nParams == null ? Collections.emptyList() : Collections.unmodifiableCollection(newArrayList(l10nParams));
}
private MessageException(String message, Throwable cause) {
super(message, cause);
l10nKey = null;
l10nParams = Collections.emptyList();
}
public static MessageException of(String message, Throwable cause) {
return new MessageException(message, cause);
}
public static MessageException of(String message) {
return new MessageException(message);
}
public static MessageException ofL10n(String l10nKey, Object... l10nParams) {
return new MessageException(null, l10nKey, l10nParams);
}
/**
* Does not fill in the stack trace
*
* @see java.lang.Throwable#fillInStackTrace()
*/
@Override
public synchronized Throwable fillInStackTrace() {
return this;
}
@Override
public String toString() {
return getMessage();
}
@CheckForNull
public String l10nKey() {
return l10nKey;
}
@CheckForNull
public Collection<Object> l10nParams() {
return l10nParams;
}
}
|
