author | jjg |
Tue, 07 Apr 2015 11:04:29 -0700 | |
changeset 29842 | 826ac2519523 |
parent 28334 | 1633de6070ae |
permissions | -rw-r--r-- |
867 | 1 |
/* |
14259 | 2 |
* Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. |
867 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
867 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
867 | 10 |
* |
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
5520 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
867 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.javac.util; |
|
27 |
||
28 |
import java.util.HashMap; |
|
29 |
import java.util.Map; |
|
30 |
import javax.tools.JavaFileObject; |
|
31 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
32 |
import com.sun.tools.javac.code.Lint.LintCategory; |
7076
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
33 |
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticFlag; |
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
34 |
import com.sun.tools.javac.util.JCDiagnostic.Error; |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
35 |
import com.sun.tools.javac.util.JCDiagnostic.Note; |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
36 |
import com.sun.tools.javac.util.JCDiagnostic.Warning; |
867 | 37 |
import com.sun.tools.javac.util.JCDiagnostic.DiagnosticPosition; |
38 |
import com.sun.tools.javac.util.JCDiagnostic.SimpleDiagnosticPosition; |
|
39 |
||
40 |
||
41 |
/** |
|
42 |
* A base class for error logs. Reports errors and warnings, and |
|
43 |
* keeps track of error numbers and positions. |
|
44 |
* |
|
5847
1908176fd6e3
6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents:
5520
diff
changeset
|
45 |
* <p><b>This is NOT part of any supported API. |
1908176fd6e3
6944312: Potential rebranding issues in openjdk/langtools repository sources
jjg
parents:
5520
diff
changeset
|
46 |
* If you write code that depends on this, you do so at your own risk. |
867 | 47 |
* This code and its internal interfaces are subject to change or |
48 |
* deletion without notice.</b> |
|
49 |
*/ |
|
50 |
public abstract class AbstractLog { |
|
22163 | 51 |
/** Factory for diagnostics |
52 |
*/ |
|
53 |
protected JCDiagnostic.Factory diags; |
|
54 |
||
55 |
/** The file that's currently being translated. |
|
56 |
*/ |
|
57 |
protected DiagnosticSource source; |
|
58 |
||
59 |
/** A cache of lightweight DiagnosticSource objects. |
|
60 |
*/ |
|
61 |
protected Map<JavaFileObject, DiagnosticSource> sourceMap; |
|
62 |
||
867 | 63 |
AbstractLog(JCDiagnostic.Factory diags) { |
64 |
this.diags = diags; |
|
22163 | 65 |
sourceMap = new HashMap<>(); |
867 | 66 |
} |
67 |
||
68 |
/** Re-assign source, returning previous setting. |
|
69 |
*/ |
|
70 |
public JavaFileObject useSource(JavaFileObject file) { |
|
71 |
JavaFileObject prev = (source == null ? null : source.getFile()); |
|
72 |
source = getSource(file); |
|
73 |
return prev; |
|
74 |
} |
|
75 |
||
76 |
protected DiagnosticSource getSource(JavaFileObject file) { |
|
77 |
if (file == null) |
|
3144
202fa249dc34
6852595: Accessing scope using JSR199 API on erroneous tree causes Illegal Argument Exception
mcimadamore
parents:
1591
diff
changeset
|
78 |
return DiagnosticSource.NO_SOURCE; |
867 | 79 |
DiagnosticSource s = sourceMap.get(file); |
80 |
if (s == null) { |
|
81 |
s = new DiagnosticSource(file, this); |
|
82 |
sourceMap.put(file, s); |
|
83 |
} |
|
84 |
return s; |
|
85 |
} |
|
86 |
||
1591 | 87 |
/** Return the underlying diagnostic source |
88 |
*/ |
|
89 |
public DiagnosticSource currentSource() { |
|
90 |
return source; |
|
91 |
} |
|
92 |
||
867 | 93 |
/** Report an error, unless another error was already reported at same |
94 |
* source position. |
|
95 |
* @param key The key for the localized error message. |
|
96 |
* @param args Fields of the error message. |
|
97 |
*/ |
|
98 |
public void error(String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
99 |
error(diags.errorKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
100 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
101 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
102 |
/** Report an error, unless another error was already reported at same |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
103 |
* source position. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
104 |
* @param errorKey The key for the localized error message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
105 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
106 |
public void error(Error errorKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
107 |
report(diags.error(null, source, null, errorKey)); |
867 | 108 |
} |
109 |
||
110 |
/** Report an error, unless another error was already reported at same |
|
111 |
* source position. |
|
112 |
* @param pos The source position at which to report the error. |
|
113 |
* @param key The key for the localized error message. |
|
114 |
* @param args Fields of the error message. |
|
115 |
*/ |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
116 |
public void error(DiagnosticPosition pos, String key, Object... args) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
117 |
error(pos, diags.errorKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
118 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
119 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
120 |
/** Report an error, unless another error was already reported at same |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
121 |
* source position. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
122 |
* @param pos The source position at which to report the error. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
123 |
* @param errorKey The key for the localized error message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
124 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
125 |
public void error(DiagnosticPosition pos, Error errorKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
126 |
report(diags.error(null, source, pos, errorKey)); |
867 | 127 |
} |
128 |
||
129 |
/** Report an error, unless another error was already reported at same |
|
130 |
* source position. |
|
10455
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
131 |
* @param flag A flag to set on the diagnostic |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
132 |
* @param pos The source position at which to report the error. |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
133 |
* @param key The key for the localized error message. |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
134 |
* @param args Fields of the error message. |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
135 |
*/ |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
136 |
public void error(DiagnosticFlag flag, DiagnosticPosition pos, String key, Object ... args) { |
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
137 |
error(flag, pos, diags.errorKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
138 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
139 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
140 |
/** Report an error, unless another error was already reported at same |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
141 |
* source position. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
142 |
* @param flag A flag to set on the diagnostic |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
143 |
* @param pos The source position at which to report the error. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
144 |
* @param errorKey The key for the localized error message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
145 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
146 |
public void error(DiagnosticFlag flag, DiagnosticPosition pos, Error errorKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
147 |
report(diags.error(flag, source, pos, errorKey)); |
10455
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
148 |
} |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
149 |
|
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
150 |
/** Report an error, unless another error was already reported at same |
3d070be0fff8
7073631: (javac) javac parser improvements for error position reporting
ksrini
parents:
7681
diff
changeset
|
151 |
* source position. |
867 | 152 |
* @param pos The source position at which to report the error. |
153 |
* @param key The key for the localized error message. |
|
154 |
* @param args Fields of the error message. |
|
155 |
*/ |
|
156 |
public void error(int pos, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
157 |
error(pos, diags.errorKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
158 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
159 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
160 |
/** Report an error, unless another error was already reported at same |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
161 |
* source position. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
162 |
* @param pos The source position at which to report the error. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
163 |
* @param errorKey The key for the localized error message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
164 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
165 |
public void error(int pos, Error errorKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
166 |
report(diags.error(null, source, wrap(pos), errorKey)); |
867 | 167 |
} |
168 |
||
7076
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
169 |
/** Report an error, unless another error was already reported at same |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
170 |
* source position. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
171 |
* @param flag A flag to set on the diagnostic |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
172 |
* @param pos The source position at which to report the error. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
173 |
* @param key The key for the localized error message. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
174 |
* @param args Fields of the error message. |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
175 |
*/ |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
176 |
public void error(DiagnosticFlag flag, int pos, String key, Object ... args) { |
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
177 |
error(flag, pos, diags.errorKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
178 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
179 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
180 |
/** Report an error, unless another error was already reported at same |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
181 |
* source position. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
182 |
* @param flag A flag to set on the diagnostic |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
183 |
* @param pos The source position at which to report the error. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
184 |
* @param errorKey The key for the localized error message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
185 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
186 |
public void error(DiagnosticFlag flag, int pos, Error errorKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
187 |
report(diags.error(flag, source, wrap(pos), errorKey)); |
7076
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
188 |
} |
c96fa26247c8
6994946: option to specify only syntax errors as unrecoverable
jjg
parents:
6151
diff
changeset
|
189 |
|
867 | 190 |
/** Report a warning, unless suppressed by the -nowarn option or the |
191 |
* maximum number of warnings has been reached. |
|
192 |
* @param key The key for the localized warning message. |
|
193 |
* @param args Fields of the warning message. |
|
194 |
*/ |
|
195 |
public void warning(String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
196 |
warning(diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
197 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
198 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
199 |
/** Report a warning, unless suppressed by the -nowarn option or the |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
200 |
* maximum number of warnings has been reached. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
201 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
202 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
203 |
public void warning(Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
204 |
report(diags.warning(null, source, null, warningKey)); |
867 | 205 |
} |
206 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
207 |
/** Report a lint warning, unless suppressed by the -nowarn option or the |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
208 |
* maximum number of warnings has been reached. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
209 |
* @param lc The lint category for the diagnostic |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
210 |
* @param key The key for the localized warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
211 |
* @param args Fields of the warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
212 |
*/ |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
213 |
public void warning(LintCategory lc, String key, Object ... args) { |
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
214 |
warning(lc, diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
215 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
216 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
217 |
/** Report a lint warning, unless suppressed by the -nowarn option or the |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
218 |
* maximum number of warnings has been reached. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
219 |
* @param lc The lint category for the diagnostic |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
220 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
221 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
222 |
public void warning(LintCategory lc, Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
223 |
report(diags.warning(lc, null, null, warningKey)); |
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
224 |
} |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
225 |
|
867 | 226 |
/** Report a warning, unless suppressed by the -nowarn option or the |
227 |
* maximum number of warnings has been reached. |
|
228 |
* @param pos The source position at which to report the warning. |
|
229 |
* @param key The key for the localized warning message. |
|
230 |
* @param args Fields of the warning message. |
|
231 |
*/ |
|
232 |
public void warning(DiagnosticPosition pos, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
233 |
warning(pos, diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
234 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
235 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
236 |
/** Report a warning, unless suppressed by the -nowarn option or the |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
237 |
* maximum number of warnings has been reached. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
238 |
* @param pos The source position at which to report the warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
239 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
240 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
241 |
public void warning(DiagnosticPosition pos, Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
242 |
report(diags.warning(null, source, pos, warningKey)); |
867 | 243 |
} |
244 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
245 |
/** Report a lint warning, unless suppressed by the -nowarn option or the |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
246 |
* maximum number of warnings has been reached. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
247 |
* @param lc The lint category for the diagnostic |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
248 |
* @param pos The source position at which to report the warning. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
249 |
* @param key The key for the localized warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
250 |
* @param args Fields of the warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
251 |
*/ |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
252 |
public void warning(LintCategory lc, DiagnosticPosition pos, String key, Object ... args) { |
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
253 |
warning(lc, pos, diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
254 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
255 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
256 |
/** Report a lint warning, unless suppressed by the -nowarn option or the |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
257 |
* maximum number of warnings has been reached. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
258 |
* @param lc The lint category for the diagnostic |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
259 |
* @param pos The source position at which to report the warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
260 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
261 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
262 |
public void warning(LintCategory lc, DiagnosticPosition pos, Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
263 |
report(diags.warning(lc, source, pos, warningKey)); |
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
264 |
} |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
265 |
|
867 | 266 |
/** Report a warning, unless suppressed by the -nowarn option or the |
267 |
* maximum number of warnings has been reached. |
|
268 |
* @param pos The source position at which to report the warning. |
|
269 |
* @param key The key for the localized warning message. |
|
270 |
* @param args Fields of the warning message. |
|
271 |
*/ |
|
272 |
public void warning(int pos, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
273 |
warning(pos, diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
274 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
275 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
276 |
/** Report a warning, unless suppressed by the -nowarn option or the |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
277 |
* maximum number of warnings has been reached. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
278 |
* @param pos The source position at which to report the warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
279 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
280 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
281 |
public void warning(int pos, Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
282 |
report(diags.warning(null, source, wrap(pos), warningKey)); |
867 | 283 |
} |
284 |
||
285 |
/** Report a warning. |
|
286 |
* @param pos The source position at which to report the warning. |
|
287 |
* @param key The key for the localized warning message. |
|
288 |
* @param args Fields of the warning message. |
|
289 |
*/ |
|
290 |
public void mandatoryWarning(DiagnosticPosition pos, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
291 |
mandatoryWarning(pos, diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
292 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
293 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
294 |
/** Report a warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
295 |
* @param pos The source position at which to report the warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
296 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
297 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
298 |
public void mandatoryWarning(DiagnosticPosition pos, Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
299 |
report(diags.mandatoryWarning(null, source, pos, warningKey)); |
867 | 300 |
} |
301 |
||
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
302 |
/** Report a warning. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
303 |
* @param lc The lint category for the diagnostic |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
304 |
* @param pos The source position at which to report the warning. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
305 |
* @param key The key for the localized warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
306 |
* @param args Fields of the warning message. |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
307 |
*/ |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
308 |
public void mandatoryWarning(LintCategory lc, DiagnosticPosition pos, String key, Object ... args) { |
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
309 |
mandatoryWarning(lc, pos, diags.warningKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
310 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
311 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
312 |
/** Report a warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
313 |
* @param lc The lint category for the diagnostic |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
314 |
* @param pos The source position at which to report the warning. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
315 |
* @param warningKey The key for the localized warning message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
316 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
317 |
public void mandatoryWarning(LintCategory lc, DiagnosticPosition pos, Warning warningKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
318 |
report(diags.mandatoryWarning(lc, source, pos, warningKey)); |
6151
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
319 |
} |
dd513881e71d
6957438: improve code for generating warning messages containing option names
jjg
parents:
5847
diff
changeset
|
320 |
|
867 | 321 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
322 |
* @param key The key for the localized notification message. |
|
323 |
* @param args Fields of the notint an error or warning message: |
|
324 |
*/ |
|
325 |
public void note(String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
326 |
note(diags.noteKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
327 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
328 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
329 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
330 |
* @param noteKey The key for the localized notification message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
331 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
332 |
public void note(Note noteKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
333 |
report(diags.note(source, null, noteKey)); |
867 | 334 |
} |
335 |
||
336 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
337 |
* @param key The key for the localized notification message. |
|
338 |
* @param args Fields of the notification message. |
|
339 |
*/ |
|
340 |
public void note(DiagnosticPosition pos, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
341 |
note(pos, diags.noteKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
342 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
343 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
344 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
345 |
* @param noteKey The key for the localized notification message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
346 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
347 |
public void note(DiagnosticPosition pos, Note noteKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
348 |
report(diags.note(source, pos, noteKey)); |
867 | 349 |
} |
350 |
||
351 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
352 |
* @param key The key for the localized notification message. |
|
353 |
* @param args Fields of the notification message. |
|
354 |
*/ |
|
355 |
public void note(int pos, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
356 |
note(pos, diags.noteKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
357 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
358 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
359 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
360 |
* @param noteKey The key for the localized notification message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
361 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
362 |
public void note(int pos, Note noteKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
363 |
report(diags.note(source, wrap(pos), noteKey)); |
867 | 364 |
} |
365 |
||
366 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
367 |
* @param key The key for the localized notification message. |
|
368 |
* @param args Fields of the notification message. |
|
369 |
*/ |
|
370 |
public void note(JavaFileObject file, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
371 |
note(file, diags.noteKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
372 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
373 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
374 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
375 |
* @param noteKey The key for the localized notification message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
376 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
377 |
public void note(JavaFileObject file, Note noteKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
378 |
report(diags.note(getSource(file), null, noteKey)); |
867 | 379 |
} |
380 |
||
381 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
|
382 |
* @param key The key for the localized notification message. |
|
383 |
* @param args Fields of the notification message. |
|
384 |
*/ |
|
385 |
public void mandatoryNote(final JavaFileObject file, String key, Object ... args) { |
|
28334
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
386 |
mandatoryNote(file, diags.noteKey(key, args)); |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
387 |
} |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
388 |
|
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
389 |
/** Provide a non-fatal notification, unless suppressed by the -nowarn option. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
390 |
* @param noteKey The key for the localized notification message. |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
391 |
*/ |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
392 |
public void mandatoryNote(final JavaFileObject file, Note noteKey) { |
1633de6070ae
8058542: Devise scheme for better diagnostic creation
mcimadamore
parents:
25874
diff
changeset
|
393 |
report(diags.mandatoryNote(getSource(file), noteKey)); |
867 | 394 |
} |
395 |
||
396 |
protected abstract void report(JCDiagnostic diagnostic); |
|
397 |
||
398 |
protected abstract void directError(String key, Object... args); |
|
399 |
||
400 |
private DiagnosticPosition wrap(int pos) { |
|
401 |
return (pos == Position.NOPOS ? null : new SimpleDiagnosticPosition(pos)); |
|
402 |
} |
|
403 |
} |