Package Summary  Overview Summary

class:Diagnostic [NONE]
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

field:NOPOS [NONE]

method:getKind() [NONE]

  • getKind

    Diagnostic.Kind getKind()
    Returns the kind of this diagnostic, for example, error or warning.
    Returns:
    the kind of this diagnostic

    • method:getSource() [NONE]

    getSource

    S getSource()
    Returns 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.

    method:getPosition() [NONE]

    getPosition

    long getPosition()
    Returns 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 if getSource() would return null or if no location is suitable

    method:getStartPosition() [NONE]

    getStartPosition

    long getStartPosition()
    Returns 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 if getPosition() returns NOPOS

    method:getEndPosition() [NONE]

    getEndPosition

    long getEndPosition()
    Returns 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 if getPosition() returns NOPOS

    method:getLineNumber() [NONE]

    getLineNumber

    long getLineNumber()
    Returns the line number of the character offset returned by getPosition().
    Returns:
    a line number or NOPOS if and only if getPosition() returns NOPOS

    method:getColumnNumber() [NONE]

    getColumnNumber

    long getColumnNumber()
    Returns the column number of the character offset returned by getPosition().
    Returns:
    a column number or NOPOS if and only if getPosition() returns NOPOS

    method:getCode() [NONE]

    getCode

    String getCode()
    Returns a diagnostic code indicating the type of diagnostic. The code is implementation-dependent and might be null.
    Returns:
    a diagnostic code

    method:getMessage(java.util.Locale) [NONE]

    getMessage

    String getMessage​(Locale locale)
    Returns a localized message for the given locale. The actual message is implementation-dependent. If the locale is null use the default locale.
    Parameters:
    locale - a locale; might be null
    Returns:
    a localized message

    © 2020 Oracle Corporation and/or its affiliates