src/share/classes/com/sun/tools/javac/util/RawDiagnosticFormatter.java

Mon, 27 Jul 2009 19:52:42 -0700

author
jjg
date
Mon, 27 Jul 2009 19:52:42 -0700
changeset 333
7c2d6da61646
parent 288
d402db1005ad
child 415
49359d0e6a9c
permissions
-rw-r--r--

6865399: some javac files are missing Sun internal API comment
Reviewed-by: darcy

mcimadamore@83 1 /*
xdono@229 2 * Copyright 2008-2009 Sun Microsystems, Inc. All Rights Reserved.
mcimadamore@83 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mcimadamore@83 4 *
mcimadamore@83 5 * This code is free software; you can redistribute it and/or modify it
mcimadamore@83 6 * under the terms of the GNU General Public License version 2 only, as
mcimadamore@83 7 * published by the Free Software Foundation. Sun designates this
mcimadamore@83 8 * particular file as subject to the "Classpath" exception as provided
mcimadamore@83 9 * by Sun in the LICENSE file that accompanied this code.
mcimadamore@83 10 *
mcimadamore@83 11 * This code is distributed in the hope that it will be useful, but WITHOUT
mcimadamore@83 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mcimadamore@83 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
mcimadamore@83 14 * version 2 for more details (a copy is included in the LICENSE file that
mcimadamore@83 15 * accompanied this code).
mcimadamore@83 16 *
mcimadamore@83 17 * You should have received a copy of the GNU General Public License version
mcimadamore@83 18 * 2 along with this work; if not, write to the Free Software Foundation,
mcimadamore@83 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mcimadamore@83 20 *
mcimadamore@83 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
mcimadamore@83 22 * CA 95054 USA or visit www.sun.com if you need additional information or
mcimadamore@83 23 * have any questions.
mcimadamore@83 24 */
mcimadamore@83 25 package com.sun.tools.javac.util;
mcimadamore@83 26
mcimadamore@221 27 import java.util.Collection;
mcimadamore@221 28 import java.util.EnumSet;
mcimadamore@83 29 import java.util.Locale;
mcimadamore@83 30
mcimadamore@221 31 import com.sun.tools.javac.api.DiagnosticFormatter.Configuration.*;
mcimadamore@83 32 import com.sun.tools.javac.api.Formattable;
mcimadamore@221 33 import com.sun.tools.javac.util.AbstractDiagnosticFormatter.SimpleConfiguration;
mcimadamore@221 34
mcimadamore@83 35 import static com.sun.tools.javac.api.DiagnosticFormatter.PositionKind.*;
mcimadamore@83 36
mcimadamore@83 37 /**
mcimadamore@83 38 * A raw formatter for diagnostic messages.
mcimadamore@83 39 * The raw formatter will format a diagnostic according to one of two format patterns, depending on whether
mcimadamore@83 40 * or not the source name and position are set. This formatter provides a standardized, localize-independent
mcimadamore@83 41 * implementation of a diagnostic formatter; as such, this formatter is best suited for testing purposes.
jjg@333 42 *
jjg@333 43 * <p><b>This is NOT part of any API supported by Sun Microsystems.
jjg@333 44 * If you write code that depends on this, you do so at your own risk.
jjg@333 45 * This code and its internal interfaces are subject to change or
jjg@333 46 * deletion without notice.</b>
mcimadamore@83 47 */
mcimadamore@221 48 public final class RawDiagnosticFormatter extends AbstractDiagnosticFormatter {
mcimadamore@83 49
mcimadamore@83 50 /**
mcimadamore@83 51 * Create a formatter based on the supplied options.
mcimadamore@83 52 * @param msgs
mcimadamore@83 53 */
mcimadamore@221 54 public RawDiagnosticFormatter(Options options) {
mcimadamore@221 55 super(null, new SimpleConfiguration(options,
mcimadamore@221 56 EnumSet.of(DiagnosticPart.SUMMARY,
mcimadamore@221 57 DiagnosticPart.DETAILS,
mcimadamore@221 58 DiagnosticPart.SUBDIAGNOSTICS)));
mcimadamore@83 59 }
mcimadamore@83 60
mcimadamore@83 61 //provide common default formats
mcimadamore@238 62 public String formatDiagnostic(JCDiagnostic d, Locale l) {
mcimadamore@83 63 try {
mcimadamore@83 64 StringBuffer buf = new StringBuffer();
mcimadamore@83 65 if (d.getPosition() != Position.NOPOS) {
mcimadamore@100 66 buf.append(formatSource(d, false, null));
mcimadamore@83 67 buf.append(':');
mcimadamore@83 68 buf.append(formatPosition(d, LINE, null));
mcimadamore@83 69 buf.append(':');
mcimadamore@83 70 buf.append(formatPosition(d, COLUMN, null));
mcimadamore@83 71 buf.append(':');
mcimadamore@83 72 }
mcimadamore@83 73 else
mcimadamore@83 74 buf.append('-');
mcimadamore@83 75 buf.append(' ');
mcimadamore@83 76 buf.append(formatMessage(d, null));
mcimadamore@137 77 if (displaySource(d))
mcimadamore@221 78 buf.append("\n" + formatSourceLine(d, 0));
mcimadamore@83 79 return buf.toString();
mcimadamore@83 80 }
mcimadamore@83 81 catch (Exception e) {
mcimadamore@83 82 e.printStackTrace();
mcimadamore@83 83 return null;
mcimadamore@83 84 }
mcimadamore@83 85 }
mcimadamore@83 86
mcimadamore@221 87 public String formatMessage(JCDiagnostic d, Locale l) {
mcimadamore@221 88 StringBuilder buf = new StringBuilder();
mcimadamore@221 89 Collection<String> args = formatArguments(d, l);
mcimadamore@238 90 buf.append(localize(null, d.getCode(), args.toArray()));
mcimadamore@221 91 if (d.isMultiline() && getConfiguration().getVisible().contains(DiagnosticPart.SUBDIAGNOSTICS)) {
mcimadamore@221 92 List<String> subDiags = formatSubdiagnostics(d, null);
mcimadamore@221 93 if (subDiags.nonEmpty()) {
mcimadamore@238 94 String sep = "";
mcimadamore@221 95 buf.append(",{");
mcimadamore@221 96 for (String sub : formatSubdiagnostics(d, null)) {
mcimadamore@221 97 buf.append(sep);
mcimadamore@221 98 buf.append("(" + sub + ")");
mcimadamore@221 99 sep = ",";
mcimadamore@221 100 }
mcimadamore@221 101 buf.append('}');
mcimadamore@221 102 }
mcimadamore@221 103 }
mcimadamore@221 104 return buf.toString();
mcimadamore@221 105 }
mcimadamore@221 106
mcimadamore@83 107 @Override
mcimadamore@83 108 protected String formatArgument(JCDiagnostic diag, Object arg, Locale l) {
mcimadamore@83 109 String s;
mcimadamore@83 110 if (arg instanceof Formattable)
mcimadamore@83 111 s = arg.toString();
mcimadamore@83 112 else
mcimadamore@83 113 s = super.formatArgument(diag, arg, null);
mcimadamore@83 114 if (arg instanceof JCDiagnostic)
mcimadamore@83 115 return "(" + s + ")";
mcimadamore@83 116 else
mcimadamore@83 117 return s;
mcimadamore@83 118 }
mcimadamore@238 119
mcimadamore@238 120 @Override
mcimadamore@238 121 protected String localize(Locale l, String key, Object... args) {
mcimadamore@238 122 StringBuilder buf = new StringBuilder();
mcimadamore@238 123 buf.append(key);
mcimadamore@238 124 String sep = ": ";
mcimadamore@238 125 for (Object o : args) {
mcimadamore@238 126 buf.append(sep);
mcimadamore@238 127 buf.append(o);
mcimadamore@238 128 sep = ", ";
mcimadamore@238 129 }
mcimadamore@238 130 return buf.toString();
mcimadamore@238 131 }
mcimadamore@288 132
mcimadamore@288 133 @Override
mcimadamore@288 134 public boolean isRaw() {
mcimadamore@288 135 return true;
mcimadamore@288 136 }
mcimadamore@83 137 }

mercurial