1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/javac/api/DiagnosticFormatter.java Mon Jul 28 10:22:10 2008 +0100
1.3 @@ -0,0 +1,117 @@
1.4 +/*
1.5 + * Copyright 2008 Sun Microsystems, Inc. All Rights Reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Sun designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Sun in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + * have any questions.
1.27 + */
1.28 +package com.sun.tools.javac.api;
1.29 +
1.30 +import java.util.Locale;
1.31 +import javax.tools.Diagnostic;
1.32 +
1.33 +/**
1.34 + * Provides simple functionalities for javac diagnostic formatting
1.35 + * @param <D> type of diagnostic handled by this formatter
1.36 + */
1.37 +public interface DiagnosticFormatter<D extends Diagnostic<?>> {
1.38 +
1.39 + /**
1.40 + * Whether the source code output for this diagnostic is to be displayed
1.41 + *
1.42 + * @param diag diagnostic to be formatted
1.43 + * @return true if the source line this diagnostic refers to is to be displayed
1.44 + */
1.45 + boolean displaySource(D diag);
1.46 +
1.47 + /**
1.48 + * Format the contents of a diagnostics
1.49 + *
1.50 + * @param diag the diagnostic to be formatted
1.51 + * @param l locale object to be used for i18n
1.52 + * @return a string representing the diagnostic
1.53 + */
1.54 + public String format(D diag, Locale l);
1.55 +
1.56 + /**
1.57 + * Controls the way in which a diagnostic message is displayed.
1.58 + *
1.59 + * @param diag diagnostic to be formatted
1.60 + * @param l locale object to be used for i18n
1.61 + * @return string representation of the diagnostic message
1.62 + */
1.63 + public String formatMessage(D diag,Locale l);
1.64 +
1.65 + /**
1.66 + * Controls the way in which a diagnostic kind is displayed.
1.67 + *
1.68 + * @param diag diagnostic to be formatted
1.69 + * @param l locale object to be used for i18n
1.70 + * @return string representation of the diagnostic prefix
1.71 + */
1.72 + public String formatKind(D diag, Locale l);
1.73 +
1.74 + /**
1.75 + * Controls the way in which a diagnostic source is displayed.
1.76 + *
1.77 + * @param diag diagnostic to be formatted
1.78 + * @param l locale object to be used for i18n
1.79 + * @return string representation of the diagnostic source
1.80 + */
1.81 + public String formatSource(D diag, Locale l);
1.82 +
1.83 + /**
1.84 + * Controls the way in which a diagnostic position is displayed.
1.85 + *
1.86 + * @param diag diagnostic to be formatted
1.87 + * @param pk enum constant representing the position kind
1.88 + * @param l locale object to be used for i18n
1.89 + * @return string representation of the diagnostic position
1.90 + */
1.91 + public String formatPosition(D diag, PositionKind pk, Locale l);
1.92 + //where
1.93 + /**
1.94 + * This enum defines a set of constants for all the kinds of position
1.95 + * that a diagnostic can be asked for. All positions are intended to be
1.96 + * relative to a given diagnostic source.
1.97 + */
1.98 + public enum PositionKind {
1.99 + /**
1.100 + * Start position
1.101 + */
1.102 + START,
1.103 + /**
1.104 + * End position
1.105 + */
1.106 + END,
1.107 + /**
1.108 + * Line number
1.109 + */
1.110 + LINE,
1.111 + /**
1.112 + * Column number
1.113 + */
1.114 + COLUMN,
1.115 + /**
1.116 + * Offset position
1.117 + */
1.118 + OFFSET
1.119 + }
1.120 +}
