public class Diagnostic
extends java.lang.Object
implements java.io.Serializable
A diagnostic object contains a system severity level, a user severity level, a message, an optional location, an optional numeric code and an optional exception element. This class does not put any restrictions on the form and meaning of location and numeric codes. Such semantics should be published explicitly by the generator of the diagnostic object so that the interpretation of these fields can be done by users unambiguously.
Modifier and Type | Class and Description |
---|---|
static class |
Diagnostic.Severity
Enumerated type that describes how this status should be interpreted by the configuration framework.
|
static class |
Diagnostic.UserSeverity
Describes the user visible severity of the diagnostic message.
|
Constructor and Description |
---|
Diagnostic(Diagnostic.Severity severity, Diagnostic.UserSeverity userSeverity, int code, java.lang.Object location, java.lang.String message, java.lang.Exception exception)
Create a diagnostic object with the given arguments.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
int |
getCode()
Returns the user given code
|
java.lang.Throwable |
getException()
Returns the exception if any.
|
java.lang.Object |
getLocation()
Returns the location that this diagnostic message refers to.
|
java.lang.String |
getMessage()
Returns the diagnostic message
|
Diagnostic.Severity |
getSeverity()
The severity of this diagnostic object.
|
Diagnostic.UserSeverity |
getUserSeverity()
Returns the user visible severity of this object
|
int |
hashCode() |
static Diagnostic |
mkCannotCommit(int code, java.lang.Object location, java.lang.String message, java.lang.Exception ex)
Creates a Diagnostic object with CannotCommit severity.
|
static Diagnostic |
mkCannotCreate(int code, java.lang.Object location, java.lang.String message, java.lang.Exception ex)
Creates a Diagnostic object with CannotCreate severity.
|
static Diagnostic |
mkValid(Diagnostic.UserSeverity userSeverity, int code, java.lang.Object location, java.lang.String message)
Creates a Diagnostic object with Valid severity.
|
public Diagnostic(Diagnostic.Severity severity, Diagnostic.UserSeverity userSeverity, int code, java.lang.Object location, java.lang.String message, java.lang.Exception exception)
severity
- the severity level for this diagnostic message. Cannot be null.code
- optional numeric code for this diagnostic object, whose semantics must be published elsewhere.location
- optional location where this diagnostic object relates to. The semantic of the location field must be published elsewhere.message
- optional the message. If null, the exception must be non-null.exception
- optional exception. if null, the message must be non-null.public static Diagnostic mkValid(Diagnostic.UserSeverity userSeverity, int code, java.lang.Object location, java.lang.String message)
public static Diagnostic mkCannotCommit(int code, java.lang.Object location, java.lang.String message, java.lang.Exception ex)
public static Diagnostic mkCannotCreate(int code, java.lang.Object location, java.lang.String message, java.lang.Exception ex)
public Diagnostic.Severity getSeverity()
public Diagnostic.UserSeverity getUserSeverity()
public int getCode()
public java.lang.Object getLocation()
public java.lang.String getMessage()
public java.lang.Throwable getException()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object