org.jamplate.impl.diagnostic

Class MessageImpl

java.lang.Object

org.jamplate.impl.diagnostic.MessageImpl

All Implemented Interfaces:

java.io.Serializable, Message

public class MessageImpl
extends java.lang.Object
implements Message

A basic implementation of the interface Message.

Since:

0.2.0 ~2021.05.31

Version:

0.2.0

Author:

LSafer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected @NotNull Tree[]	criticalPoints The critical points.
protected @NotNull java.lang.String	errorKind The error kind.
protected @Nullable java.lang.Throwable	exception The exception.
protected boolean	fetal True, if the error is fetal.
protected @NotNull java.lang.String	messagePhrase The message phrase.
protected @NotNull java.lang.String	priority The message priority.
protected @NotNull Tree[]	stackTrace The stack trace.

Constructor Summary

Constructors

Constructor and Description
MessageImpl(@NotNull java.lang.String messagePhrase, @NotNull Memory memory, @NotNull java.lang.String priority, @NotNull java.lang.String errorKind, boolean fetal, Tree... criticalPoints) Construct a new message.
MessageImpl(@NotNull java.lang.String messagePhrase, @NotNull java.lang.String priority, @NotNull java.lang.String errorKind, boolean fetal, Tree... criticalPoints) Construct a new message.
MessageImpl(@NotNull java.lang.Throwable exception, @NotNull Memory memory, @NotNull java.lang.String priority, @NotNull java.lang.String errorKind, boolean fetal, Tree... criticalPoints) Construct a new message.
MessageImpl(@NotNull java.lang.Throwable exception, @NotNull java.lang.String priority, @NotNull java.lang.String errorKind, boolean fetal, Tree... criticalPoints) Construct a new message.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

criticalPoints

@NotNull
protected final @NotNull Tree[] criticalPoints

The critical points.

Since:

0.2.0 ~2021.05.31

errorKind

@NotNull
protected final @NotNull java.lang.String errorKind

The error kind.

Since:

0.2.0 ~2021.05.31

exception

@Nullable
protected final @Nullable java.lang.Throwable exception

The exception.

Since:

0.2.0 ~2021.05.31

fetal

protected final boolean fetal

True, if the error is fetal.

Since:

0.2.0 ~2021.05.31

messagePhrase

@NotNull
protected final @NotNull java.lang.String messagePhrase

The message phrase.

Since:

0.2.0 ~2021.05.31

priority

@NotNull
protected final @NotNull java.lang.String priority

The message priority.

Since:

0.2.0 ~2021.05.31

stackTrace

@NotNull
protected final @NotNull Tree[] stackTrace

The stack trace.

Since:

0.2.0 ~2021.05.31

Constructor Detail

MessageImpl

public MessageImpl(@NotNull
                   @NotNull java.lang.Throwable exception,
                   @NotNull
                   @NotNull java.lang.String priority,
                   @NotNull
                   @NotNull java.lang.String errorKind,
                   boolean fetal,
                   @Nullable
                   Tree... criticalPoints)

Construct a new message.

Parameters:

exception - the exception the construction will represent.

priority - the priority of the constructed message.

errorKind - the kind of the error.

fetal - true, if the error is a fetal error.

criticalPoints - the critical points where the exception concurred.

Throws:

java.lang.NullPointerException - if the given exception or priority or errorKind or criticalPoints is null.

Since:

0.2.0 ~2021.05.31

MessageImpl

public MessageImpl(@NotNull
                   @NotNull java.lang.String messagePhrase,
                   @NotNull
                   @NotNull java.lang.String priority,
                   @NotNull
                   @NotNull java.lang.String errorKind,
                   boolean fetal,
                   @Nullable
                   Tree... criticalPoints)

Construct a new message.

Parameters:

messagePhrase - the message phrase of the constructed message.

priority - the priority of the constructed message.

errorKind - the kind of the error.

fetal - true, if the error is a fetal error.

criticalPoints - the critical points where the exception concurred.

Throws:

java.lang.NullPointerException - if the given messagePhrase or priority or errorKind or criticalPoints is null.

Since:

0.2.0 ~2021.05.31

MessageImpl

public MessageImpl(@NotNull
                   @NotNull java.lang.Throwable exception,
                   @NotNull
                   @NotNull Memory memory,
                   @NotNull
                   @NotNull java.lang.String priority,
                   @NotNull
                   @NotNull java.lang.String errorKind,
                   boolean fetal,
                   @Nullable
                   Tree... criticalPoints)

Construct a new message.

Parameters:

exception - the exception the construction will represent.

memory - the memory at the time of the occurrence of the error.

priority - the priority of the constructed message.

errorKind - the kind of the error.

fetal - true, if the error is a fetal error.

criticalPoints - the critical points where the exception concurred.

Throws:

java.lang.NullPointerException - if the given exception or memory or priority or errorKind or criticalPoints is null.

Since:

0.2.0 ~2021.05.31

MessageImpl

public MessageImpl(@NotNull
                   @NotNull java.lang.String messagePhrase,
                   @NotNull
                   @NotNull Memory memory,
                   @NotNull
                   @NotNull java.lang.String priority,
                   @NotNull
                   @NotNull java.lang.String errorKind,
                   boolean fetal,
                   @Nullable
                   Tree... criticalPoints)

Construct a new message.

Parameters:

messagePhrase - the message phrase of the constructed message.

memory - the memory at the time of the occurrence of the error.

priority - the priority of the constructed message.

errorKind - the kind of the error.

fetal - true, if the error is a fetal error.

criticalPoints - the critical points where the exception concurred.

Throws:

java.lang.NullPointerException - if the given messagePhrase or memory or priority or errorKind or criticalPoints is null.

Since:

0.2.0 ~2021.05.31

Method Detail

getCriticalPoints

@NotNull
public @NotNull Tree[] getCriticalPoints()

Description copied from interface: Message

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

Specified by:

getCriticalPoints in interface Message

Returns:

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

getErrorKind

@NotNull
public @NotNull java.lang.String getErrorKind()

Description copied from interface: Message

Return the kind of the error of this message.

Specified by:

getErrorKind in interface Message

Returns:

the kind of the error.

getException

@Nullable
public @Nullable java.lang.Throwable getException()

Description copied from interface: Message

Return the exception caused this message.

Specified by:

getException in interface Message

Returns:

the exception of this message. Or null if none.

getMessagePhrase

@NotNull
public @NotNull java.lang.String getMessagePhrase()

Description copied from interface: Message

Return the message phrase.

Specified by:

getMessagePhrase in interface Message

Returns:

the message phrase.

getPriority

@NotNull
public @NotNull java.lang.String getPriority()

Description copied from interface: Message

Return the priority of this message.

Specified by:

getPriority in interface Message

Returns:

the priority of this message.

getStackTrace

@NotNull
public @NotNull Tree[] getStackTrace()

Description copied from interface: Message

Return the trace of the error.

Specified by:

getStackTrace in interface Message

Returns:

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

isFetal

public boolean isFetal()

Description copied from interface: Message

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

Specified by:

isFetal in interface Message

Returns:

true, if this message represents a fetal error.