javax.tools

Interface Diagnostic<S>

public interface Diagnostic<S>

Encapsulates diagnostic information from a tool. This usually includes (but is not required) a position in a source file, line and column number information and a message.
Since:
1.6

Nested Class Summary

static class
Diagnostic.Kind
The kind of diagnostic information.

Field Summary

static long
NOPOS
Indicates that this diagnostic object doesn't carry position information.

Method Summary

String
getCode()
Return a diagnostic code.
long
getColumnNumber()
Returns the column number or NOPOS, indicating that this doesn't carry position information.
long
getEndPosition()
Diagnostic.Kind
getKind()
Returns the kind of this diagnostic object.
long
getLineNumber()
Returns the line number or NOPOS, indicating that this doesn't carry position information.
String
getMessage(Locale locale)
Returns a localized message.
long
getPosition()
Returns the position in the source object.
S
getSource()
Returns the source of this diagnostic object.
long
getStartPosition()
Returns the start position in the source object.

Field Details

NOPOS

public static final long NOPOS
Indicates that this diagnostic object doesn't carry position information.
Field Value:
-1L

Method Details

getCode

public String getCode()
Return a diagnostic code. This is implementation dependend and might be null.
Returns:
a diagnostic code or null

getColumnNumber

public long getColumnNumber()
Returns the column number or NOPOS, indicating that this doesn't carry position information. This is a 1-based value indicating the column in the source object.
Returns:
the column number

getEndPosition

public long getEndPosition()

getKind

public Diagnostic.Kind getKind()
Returns the kind of this diagnostic object.
Returns:
the kind of this diagnostic object

getLineNumber

public long getLineNumber()
Returns the line number or NOPOS, indicating that this doesn't carry position information. This is a 1-based value indicating the line in the source object.
Returns:
the line number

getMessage

public String getMessage(Locale locale)
Returns a localized message. This is implementation dependend. If locale is null this uses the default locale.
Parameters:
locale - the locale, or null
Returns:
a localized message

getPosition

public long getPosition()
Returns the position in the source object. This is a zero based value, or NOPOS, indicating that this doesn't carry position information.
Returns:
the position in the source object

getSource

public S getSource()
Returns the source of this diagnostic object.
Returns:
the source of this diagnostic object

getStartPosition

public long getStartPosition()
Returns the start position in the source object. This is a zero based value, or NOPOS, indicating that this doesn't carry position information.
Returns:
the start position in the source object

Diagnostic.java -- Copyright (C) 2008 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.