Package org.eclipse.emf.common.util

Interface Diagnostic

All Known Implementing Classes:
BasicDiagnostic
public interface Diagnostic
Information about the outcome of some activity.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CANCEL
    The bit mask value 0x8 for a severity indicating that the diagnosis was canceled.
    static final Diagnostic
    CANCEL_INSTANCE
    A diagnostic indicating that the diagnosis was canceled.
    static final int
    ERROR
    The bit mask value 0x4 for a severity indicating there is an error message.
    static final int
    INFO
    The bit mask value 0x1 for a severity indicating there is an informational message.
    static final int
    OK
    The bit mask value 0x0 for a severity indicating everything is okay.
    static final Diagnostic
    OK_INSTANCE
    A diagnostic indicating that everything is okay.
    static final int
    WARNING
    The bit mask value 0x2 for a severity indicating there is warning message.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<Diagnostic>
    getChildren()
    Returns the list of child diagnostics.
    int
    getCode()
    Returns source-specific identity code.
    List<?>
    getData()
    Returns the arbitrary associated list of data.
    Throwable
    getException()
    Returns the relevant low-level exception, or null if none.
    String
    getMessage()
    Returns a message describing the situation.
    int
    getSeverity()
    Returns an indicator of the severity of the problem.
    String
    getSource()
    Returns the unique identifier of the source.

  • Field Details

    • OK

      static final int OK
      The bit mask value 0x0 for a severity indicating everything is okay.
      See Also:

    • INFO

      static final int INFO
      The bit mask value 0x1 for a severity indicating there is an informational message.
      See Also:

    • WARNING

      static final int WARNING
      The bit mask value 0x2 for a severity indicating there is warning message.
      See Also:

    • ERROR

      static final int ERROR
      The bit mask value 0x4 for a severity indicating there is an error message.
      See Also:

    • CANCEL

      static final int CANCEL
      The bit mask value 0x8 for a severity indicating that the diagnosis was canceled.
      See Also:

    • OK_INSTANCE

      static final Diagnostic OK_INSTANCE
      A diagnostic indicating that everything is okay.

    • CANCEL_INSTANCE

      static final Diagnostic CANCEL_INSTANCE
      A diagnostic indicating that the diagnosis was canceled.

  • Method Details

    • getSeverity

      int getSeverity()
      Returns an indicator of the severity of the problem.

    • getMessage

      String getMessage()
      Returns a message describing the situation.

    • getSource

      String getSource()
      Returns the unique identifier of the source.

    • getCode

      int getCode()
      Returns source-specific identity code.

    • getException

      Throwable getException()
      Returns the relevant low-level exception, or null if none.

    • getData

      List<?> getData()
      Returns the arbitrary associated list of data. The first element is typically the object that is the primary source of the problem; the second element is typically some object describing the problematic feature or aspect of the primary source, and the remaining elements are additional objects associated with or describing the problem.

    • getChildren

      List<Diagnostic> getChildren()
      Returns the list of child diagnostics.