org.jamplate.diagnostic

Interface Message

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

MessageImpl

public interface Message
extends java.io.Serializable

A diagnostic message containing the details about an error, warning or even a note.

Since:

0.2.0 ~2021.05.17

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
@NotNull Tree[]	getCriticalPoints() Return the critical points trees that caused the error represented by this message.
@NotNull java.lang.String	getErrorKind() Return the kind of the error of this message.
@Nullable java.lang.Throwable	getException() Return the exception caused this message.
@NotNull java.lang.String	getMessagePhrase() Return the message phrase.
@NotNull java.lang.String	getPriority() Return the priority of this message.
@NotNull Tree[]	getStackTrace() Return the trace of the error.
boolean	isFetal() Return true if this message represent a fetal (unrecoverable) error.

Method Detail

getCriticalPoints

@NotNull
 @Contract(value="->new",
          pure=true)
@NotNull Tree[] getCriticalPoints()

Return the critical points trees that caused the error represented by this message.

Returns:

a clone array of the critical points trees. Or an empty array if none.

Since:

0.2.0 ~2021.05.31

getErrorKind

@NotNull
 @Contract(pure=true)
@NotNull java.lang.String getErrorKind()

Return the kind of the error of this message.

Returns:

the kind of the error.

Since:

0.2.0 ~2021.05.31

getException

@Nullable
 @Contract(pure=true)
@Nullable java.lang.Throwable getException()

Return the exception caused this message.

Returns:

the exception of this message. Or null if none.

Since:

0.2.0 ~2021.05.31

getMessagePhrase

@NotNull
 @Contract(pure=true)
@NotNull java.lang.String getMessagePhrase()

Return the message phrase.

Returns:

the message phrase.

Since:

0.2.0 ~2021.05.31

getPriority

@NotNull
 @Contract(pure=true)
@NotNull java.lang.String getPriority()

Return the priority of this message.

Returns:

the priority of this message.

Since:

0.2.0 ~2021.05.31

getStackTrace

@NotNull
 @Contract(value="->new",
          pure=true)
@NotNull Tree[] getStackTrace()

Return the trace of the error.

Returns:

the trace of the error, or an empty array if none.

Since:

0.2.0 ~2021.05.31

isFetal

@Contract(pure=true)
boolean isFetal()

Return true if this message represent a fetal (unrecoverable) error.

Returns:

true, if this message represents a fetal error.

Since:

0.2.0 ~2021.05.31