Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.exception

Class ApplicationError

java.lang.Object

java.lang.Throwable

java.lang.Error

org.tquadrat.foundation.exception.ApplicationError

All Implemented Interfaces:

Serializable

@ClassVersion(sourceVersion="$Id: ApplicationError.java 1119 2024-03-16 09:03:57Z tquadrat $")
@API(status=STABLE,
     since="0.0.5")
public class ApplicationError
extends Error

Use the application error to signal the abort of an application.

This implementation of Error allows to set a flag that indicates whether this instance was already logged or not. The flag is honoured by some methods in Foundation Logging.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ApplicationError.java 1119 2024-03-16 09:03:57Z tquadrat $

Since:

0.0.5

See Also:

• Serialized Form

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.exception.ApplicationError"

⁠

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	m_IsAlreadyLogged	A flag that indicates if the causing exception or the error condition was already logged.

Constructor Summary

Constructors

Constructor	Description
ApplicationError(String message)	Creates a new ApplicationError instance.
ApplicationError(String message, boolean isLogged)	Creates a new ApplicationError instance.
ApplicationError(String message, Throwable cause)	Creates a new ApplicationError instance.
ApplicationError(String message, Throwable cause, boolean isLogged)	Creates a new ApplicationError instance.
ApplicationError(Throwable cause)	Creates a new ApplicationError instance.
ApplicationError(Throwable cause, boolean isLogged)	Creates a new ApplicationError instance.

Method Summary

Modifier and Type	Method	Description
final boolean	isLogged()	Returns the 'is logged' flag.
final void	setLogged()	Sets the 'is logged' flag to true.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

m_IsAlreadyLogged

private boolean m_IsAlreadyLogged

A flag that indicates if the causing exception or the error condition was already logged.

Constructor Details

ApplicationError

public ApplicationError(String message)

Creates a new ApplicationError instance. The 'isLogged' flag is set to false.

Parameters:

message - The detail message. It is saved for later retrieval by the Throwable.getMessage() method.

See Also:

• Error(String)

ApplicationError

public ApplicationError(String message,
 boolean isLogged)

Creates a new ApplicationError instance.

Parameters:

message - The detail message. It is saved for later retrieval by the Throwable.getMessage() method.

isLogged - true if the error condition or the causing exception was already logged, false if it still has to be logged.

ApplicationError

public ApplicationError(Throwable cause)

Creates a new ApplicationError instance. The 'isLogged' flag is set to false.

Parameters:

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). Different from Error(Throwable) is null not a valid value.

See Also:

• Error(Throwable)

ApplicationError

public ApplicationError(Throwable cause,
 boolean isLogged)

Creates a new ApplicationError instance.

Parameters:

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). Different from Error(Throwable) is null not a valid value.

isLogged - true if the error condition or the causing exception was already logged, false if it still has to be logged.

ApplicationError

public ApplicationError(String message,
 Throwable cause)

Creates a new ApplicationError instance. The 'isLogged' flag is set to false.

Parameters:

message - The detail message. It is saved for later retrieval by the Throwable.getMessage() method.

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). Different from Error(Throwable) is null not a valid value.

See Also:

• Error(String, Throwable)

ApplicationError

public ApplicationError(String message,
 Throwable cause,
 boolean isLogged)

Creates a new ApplicationError instance.

Parameters:

message - The detail message. It is saved for later retrieval by the Throwable.getMessage() method.

cause - The cause (which is saved for later retrieval by the Throwable.getCause() method). Different from Error(Throwable) is null not a valid value.

isLogged - true if the error condition or the causing exception was already logged, false if it still has to be logged.

Method Details

isLogged

public final boolean isLogged()

Returns the 'is logged' flag.

Returns:

true if the error condition or the causing exception were already logged, false otherwise.

setLogged

public final void setLogged()

Sets the 'is logged' flag to true.