mcimadamore@83: /*
mcimadamore@83:  * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
mcimadamore@83:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mcimadamore@83:  *
mcimadamore@83:  * This code is free software; you can redistribute it and/or modify it
mcimadamore@83:  * under the terms of the GNU General Public License version 2 only, as
mcimadamore@83:  * published by the Free Software Foundation.  Sun designates this
mcimadamore@83:  * particular file as subject to the "Classpath" exception as provided
mcimadamore@83:  * by Sun in the LICENSE file that accompanied this code.
mcimadamore@83:  *
mcimadamore@83:  * This code is distributed in the hope that it will be useful, but WITHOUT
mcimadamore@83:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mcimadamore@83:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
mcimadamore@83:  * version 2 for more details (a copy is included in the LICENSE file that
mcimadamore@83:  * accompanied this code).
mcimadamore@83:  *
mcimadamore@83:  * You should have received a copy of the GNU General Public License version
mcimadamore@83:  * 2 along with this work; if not, write to the Free Software Foundation,
mcimadamore@83:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mcimadamore@83:  *
mcimadamore@83:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
mcimadamore@83:  * CA 95054 USA or visit www.sun.com if you need additional information or
mcimadamore@83:  * have any questions.
mcimadamore@83:  */
mcimadamore@83: package com.sun.tools.javac.api;
mcimadamore@83: 
mcimadamore@83: import java.util.Locale;
mcimadamore@83: import javax.tools.Diagnostic;
mcimadamore@83: 
mcimadamore@83: /**
mcimadamore@83:  * Provides simple functionalities for javac diagnostic formatting
mcimadamore@83:  * @param <D> type of diagnostic handled by this formatter
mcimadamore@83:  */
mcimadamore@83: public interface DiagnosticFormatter<D extends Diagnostic<?>> {
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Whether the source code output for this diagnostic is to be displayed
mcimadamore@83:      *
mcimadamore@83:      * @param diag diagnostic to be formatted
mcimadamore@83:      * @return true if the source line this diagnostic refers to is to be displayed
mcimadamore@83:      */
mcimadamore@83:     boolean displaySource(D diag);
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Format the contents of a diagnostics
mcimadamore@83:      *
mcimadamore@83:      * @param diag the diagnostic to be formatted
mcimadamore@83:      * @param l locale object to be used for i18n
mcimadamore@83:      * @return a string representing the diagnostic
mcimadamore@83:      */
mcimadamore@83:     public String format(D diag, Locale l);
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Controls the way in which a diagnostic message is displayed.
mcimadamore@83:      *
mcimadamore@83:      * @param diag diagnostic to be formatted
mcimadamore@83:      * @param l locale object to be used for i18n
mcimadamore@83:      * @return string representation of the diagnostic message
mcimadamore@83:      */
mcimadamore@83:     public String formatMessage(D diag,Locale l);
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Controls the way in which a diagnostic kind is displayed.
mcimadamore@83:      *
mcimadamore@83:      * @param diag diagnostic to be formatted
mcimadamore@83:      * @param l locale object to be used for i18n
mcimadamore@83:      * @return string representation of the diagnostic prefix
mcimadamore@83:      */
mcimadamore@83:     public String formatKind(D diag, Locale l);
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Controls the way in which a diagnostic source is displayed.
mcimadamore@83:      *
mcimadamore@83:      * @param diag diagnostic to be formatted
mcimadamore@83:      * @param l locale object to be used for i18n
mcimadamore@83:      * @return string representation of the diagnostic source
mcimadamore@83:      */
mcimadamore@83:     public String formatSource(D diag, Locale l);
mcimadamore@83: 
mcimadamore@83:     /**
mcimadamore@83:      * Controls the way in which a diagnostic position is displayed.
mcimadamore@83:      *
mcimadamore@83:      * @param diag diagnostic to be formatted
mcimadamore@83:      * @param pk enum constant representing the position kind
mcimadamore@83:      * @param l locale object to be used for i18n
mcimadamore@83:      * @return string representation of the diagnostic position
mcimadamore@83:      */
mcimadamore@83:     public String formatPosition(D diag, PositionKind pk, Locale l);
mcimadamore@83:     //where
mcimadamore@83:     /**
mcimadamore@83:      * This enum defines a set of constants for all the kinds of position
mcimadamore@83:      * that a diagnostic can be asked for. All positions are intended to be
mcimadamore@83:      * relative to a given diagnostic source.
mcimadamore@83:      */
mcimadamore@83:     public enum PositionKind {
mcimadamore@83:         /**
mcimadamore@83:          * Start position
mcimadamore@83:          */
mcimadamore@83:         START,
mcimadamore@83:         /**
mcimadamore@83:          * End position
mcimadamore@83:          */
mcimadamore@83:         END,
mcimadamore@83:         /**
mcimadamore@83:          * Line number
mcimadamore@83:          */
mcimadamore@83:         LINE,
mcimadamore@83:         /**
mcimadamore@83:          * Column number
mcimadamore@83:          */
mcimadamore@83:         COLUMN,
mcimadamore@83:         /**
mcimadamore@83:          * Offset position
mcimadamore@83:          */
mcimadamore@83:         OFFSET
mcimadamore@83:     }
mcimadamore@83: }