libjava/classpath/javax/tools/Diagnostic.java

   1 /* Diagnostic.java --
   2    Copyright (C) 2008  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38 package javax.tools;
  39
  40 import java.util.Locale;
  41
  42 /**
  43  * Encapsulates diagnostic information from a tool. This usually includes
  44  * (but is not required) a position in a source file, line and column number
  45  * information and a message.
  46  *
  47  * @author Roman Kennke (roman@kennke.org)
  48  *
  49  * @param <S> the type of the source object
  50  *
  51  * @since 1.6
  52  */
  53 public interface Diagnostic<S>
  54 {
  55   /**
  56    * The kind of diagnostic information.
  57    */
  58   public static enum Kind
  59   {
  60     /**
  61      * Indicates and error.
  62      */
  63     ERROR,
  64
  65     /**
  66      * Indicates a warning.
  67      */
  68     WARNING,
  69
  70     /**
  71      * Indicates a mandatory warning.
  72      */
  73     MANDATORY_WARNING,
  74
  75     /**
  76      * Indicates a note.
  77      */
  78     NOTE,
  79
  80     /**
  81      * Indicates something else.
  82      */
  83     OTHER
  84   }
  85
  86   /**
  87    * Indicates that this diagnostic object doesn't carry position information.
  88    */
  89   public static final long NOPOS = -1L;
  90
  91   /**
  92    * Returns the kind of this diagnostic object.
  93    *
  94    * @return the kind of this diagnostic object
  95    */
  96   Kind getKind();
  97
  98   /**
  99    * Returns the source of this diagnostic object.
 100    *
 101    * @return the source of this diagnostic object
 102    */
 103   S getSource();
 104
 105   /**
 106    * Returns the position in the source object. This is a zero based value,
 107    * or {@link # NOPOS}, indicating that this doesn't carry position
 108    * information.
 109    *
 110    * @return the position in the source object
 111    */
 112   long getPosition();
 113
 114   /**
 115    * Returns the start position in the source object. This is a zero based
 116    * value, or {@link #NOPOS}, indicating that this doesn't carry position
 117    * information.
 118    *
 119    * @return the start position in the source object
 120    */
 121   long getStartPosition();
 122
 123   /*
 124   * Returns the end position in the source object. This is a zero based
 125   * value, or {@link #NOPOS}, indicating that this doesn't carry position
 126   * information.
 127   *
 128   * @return the end position in the source object
 129   */
 130   long getEndPosition();
 131
 132   /**
 133    * Returns the line number or {@link #NOPOS}, indicating that this doesn't
 134    * carry position information. This is a 1-based value indicating the line
 135    * in the source object.
 136    *
 137    * @return the line number
 138    */
 139   long getLineNumber();
 140
 141   /**
 142    * Returns the column number or {@link #NOPOS}, indicating that this doesn't
 143    * carry position information. This is a 1-based value indicating the column
 144    * in the source object.
 145    *
 146    * @return the column number
 147    */
 148   long getColumnNumber();
 149
 150   /**
 151    * Return a diagnostic code. This is implementation dependend and might
 152    * be <code>null</code>.
 153    *
 154    * @return a diagnostic code or <code>null</code>
 155    */
 156   String getCode();
 157
 158   /**
 159    * Returns a localized message. This is implementation dependend. If
 160    * <code>locale</code> is <code>null</code> this uses the default locale.
 161    *
 162    * @param locale the locale, or <code>null</code>
 163    *
 164    * @return a localized message
 165    */
 166   String getMessage(Locale locale);
 167 }