org.eclipse.emf.common.util
Interface Diagnostic

All Known Implementing Classes:
BasicDiagnostic

public interface Diagnostic

Information about the outcome of some activity.


Field Summary
static int CANCEL
          The bit mask value 0x1 for a severity indicating that the diagnosis was canceled.
static Diagnostic CANCEL_INSTANCE
          A diagnostic indicating that the diagnosis was canceled.
static int ERROR
          The bit mask value 0x1 for a severity indicating there is an error message.
static int INFO
          The bit mask value 0x1 for a severity indicating there is an informational message.
static int OK
          The bit mask value 0x0 for a severity indicating everything is okay.
static Diagnostic OK_INSTANCE
          A diagnostic indicating that everything is okay.
static int WARNING
          The bit mask value 0x2 for a severity indicating there is warning message.
 
Method Summary
 List 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 Detail

OK

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

See Also:
Constant Field Values

INFO

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

See Also:
Constant Field Values

WARNING

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

See Also:
Constant Field Values

ERROR

public static final int ERROR
The bit mask value 0x1 for a severity indicating there is an error message.

See Also:
Constant Field Values

CANCEL

public static final int CANCEL
The bit mask value 0x1 for a severity indicating that the diagnosis was canceled.

See Also:
Constant Field Values

OK_INSTANCE

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


CANCEL_INSTANCE

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

Method Detail

getSeverity

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


getMessage

public String getMessage()
Returns a message describing the situation.


getSource

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


getCode

public int getCode()
Returns source-specific identity code.


getException

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


getData

public 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

public List getChildren()
Returns the list of child diagnostics.


Copyright 2001-2006 IBM Corporation and others.
All Rights Reserved.