AbstractDiagnosticFormatter.java revision 237
1N/A * Copyright 2008-2009 Sun Microsystems, Inc. All Rights Reserved. 1N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 1N/A * This code is free software; you can redistribute it and/or modify it 1N/A * under the terms of the GNU General Public License version 2 only, as 1N/A * published by the Free Software Foundation. Sun designates this 1N/A * particular file as subject to the "Classpath" exception as provided 1N/A * by Sun in the LICENSE file that accompanied this code. 1N/A * This code is distributed in the hope that it will be useful, but WITHOUT 1N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1N/A * version 2 for more details (a copy is included in the LICENSE file that 1N/A * accompanied this code). 1N/A * You should have received a copy of the GNU General Public License version 1N/A * 2 along with this work; if not, write to the Free Software Foundation, 1N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 1N/A * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, 1N/A * CA 95054 USA or visit www.sun.com if you need additional information or 1N/A * have any questions. 1N/A * This abstract class provides a basic implementation of the functionalities that should be provided 1N/A * by any formatter used by javac. Among the main features provided by AbstractDiagnosticFormatter are: 1N/A * <li> Provides a standard implementation of the visitor-like methods defined in the interface DiagnisticFormatter. 1N/A * Those implementations are specifically targeting JCDiagnostic objects. 1N/A * <li> Provides basic support for i18n and a method for executing all locale-dependent conversions 1N/A * <li> Provides the formatting logic for rendering the arguments of a JCDiagnostic object. 1N/A * JavacMessages object used by this formatter for i18n. 1N/A * Configuration object used by this formatter 1N/A * Current depth level of the disgnostic being formatted 1N/A * (!= 0 for subdiagnostics) 1N/A * Initialize an AbstractDiagnosticFormatter by setting its JavacMessages object. * Format the arguments of a given diagnostic. * @param d diagnostic whose arguments are to be formatted * @param l locale object to be used for i18n * @return a Collection whose elements are the formatted arguments of the diagnostic * Format a single argument of a given diagnostic. * @param d diagnostic whose argument is to be formatted * @param arg argument to be formatted * @param l locale object to be used for i18n * @return string representation of the diagnostic argument * Format an iterable argument of a given diagnostic. * @param d diagnostic whose argument is to be formatted * @param it iterable argument to be formatted * @param l locale object to be used for i18n * @return string representation of the diagnostic iterable argument * Format all the subdiagnostics attached to a given diagnostic. * @param d diagnostic whose subdiagnostics are to be formatted * @param l locale object to be used for i18n * @return list of all string representations of the subdiagnostics * Format a subdiagnostics attached to a given diagnostic. * @param parent multiline diagnostic whose subdiagnostics is to be formatted * @param sub subdiagnostic to be formatted * @param l locale object to be used for i18n * @return string representation of the subdiagnostics /** Format the faulty source code line and point to the error. * @param d The diagnostic for which the error line should be printed for (
int i =
0; i <
col -
1; i++) {
* Converts a String into a locale-dependent representation accordingly to a given locale. * @param l locale object to be used for i18n * @param key locale-independent key used for looking up in a resource file * @param args localization arguments * @return a locale-dependent string * Creates a string with a given amount of empty spaces. Useful for * indenting the text of a diagnostic message. * @param nSpaces the amount of spaces to be added to the result string * @return the indentation string for (
int i =
0 ; i <
nSpaces ; i++)
* Indent a string by prepending a given amount of empty spaces to each line * @param s the string to be indented * @param nSpaces the amount of spaces that should be prepended to each line * @return an indented string * Shows a '^' sign under the source line displayed by the formatter * @param caretEnabled if true enables caret * Tells whether the caret display is active or not. * @param caretEnabled if true the caret is enabled * AbstractDiagnosticFormatter. Provides alternate numbering of captured * types (they are numbered starting from 1 on each new diagnostic, instead * of relying on the underlying hashcode() method which generates unstable * output). Also detects cycles in wildcard messages (e.g. if the wildcard * type referred by a given captured type C contains C itself) which might * lead to infinite loops.