-
- Type Parameters:
S
- the type of source object used by this diagnostic
public interface Diagnostic<S>
Interface for diagnostics from tools. A diagnostic usually reports a problem at a specific position in a source file. However, not all diagnostics are associated with a position or a file.A position is a zero-based character offset from the beginning of a file. Negative values (except
NOPOS
) are not valid positions.Line and column numbers begin at 1. Negative values (except
NOPOS
) and 0 are not valid line or column numbers.- Since:
- 1.6
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static class
Diagnostic.Kind
Kinds of diagnostics, for example, error or warning.
-
Field Summary
Fields Modifier and Type Field and Description static long
NOPOS
Used to signal that no position is available.
-
Method Summary
Methods Modifier and Type Method and Description String
getCode()
Gets a diagnostic code indicating the type of diagnostic.long
getColumnNumber()
Gets the column number of the character offset returned by getPosition().long
getEndPosition()
Gets the character offset from the beginning of the file associated with this diagnostic that indicates the end of the problem.Diagnostic.Kind
getKind()
Gets the kind of this diagnostic, for example, error or warning.long
getLineNumber()
Gets the line number of the character offset returned by getPosition().String
getMessage(Locale locale)
Gets a localized message for the given locale.long
getPosition()
Gets a character offset from the beginning of the source object associated with this diagnostic that indicates the location of the problem.S
getSource()
Gets the source object associated with this diagnostic.long
getStartPosition()
Gets the character offset from the beginning of the file associated with this diagnostic that indicates the start of the problem.
-
-
-
Field Detail
-
NOPOS
static final long NOPOS
Used to signal that no position is available.- See Also:
- Constant Field Values
-
-
Method Detail
-
getKind
Diagnostic.Kind getKind()
Gets the kind of this diagnostic, for example, error or warning.- Returns:
- the kind of this diagnostic
-
getSource
S getSource()
Gets the source object associated with this diagnostic.- Returns:
- the source object associated with this diagnostic.
null
if no source object is associated with the diagnostic.
-
getPosition
long getPosition()
Gets a character offset from the beginning of the source object associated with this diagnostic that indicates the location of the problem. In addition, the following must be true:getStartPostion() <= getPosition()
getPosition() <= getEndPosition()
- Returns:
- character offset from beginning of source;
NOPOS
ifgetSource()
would returnnull
or if no location is suitable
-
getStartPosition
long getStartPosition()
Gets the character offset from the beginning of the file associated with this diagnostic that indicates the start of the problem.- Returns:
- offset from beginning of file;
NOPOS
if and only ifgetPosition()
returnsNOPOS
-
getEndPosition
long getEndPosition()
Gets the character offset from the beginning of the file associated with this diagnostic that indicates the end of the problem.- Returns:
- offset from beginning of file;
NOPOS
if and only ifgetPosition()
returnsNOPOS
-
getLineNumber
long getLineNumber()
Gets the line number of the character offset returned by getPosition().- Returns:
- a line number or
NOPOS
if and only ifgetPosition()
returnsNOPOS
-
getColumnNumber
long getColumnNumber()
Gets the column number of the character offset returned by getPosition().- Returns:
- a column number or
NOPOS
if and only ifgetPosition()
returnsNOPOS
-
getCode
String getCode()
Gets a diagnostic code indicating the type of diagnostic. The code is implementation-dependent and might benull
.- Returns:
- a diagnostic code
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/tools/diagnostic.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.