Package com.storedobject.common

Class SORuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.storedobject.common.SORuntimeException

All Implemented Interfaces:

EndUserMessage, Serializable

Direct Known Subclasses:

Database_Message, Design_Error, Error_Running_SQL, Get_Not_Allowed, Serial_Not_Generated, Set_Not_Allowed, SOClassError, SOError

public class SORuntimeException
extends RuntimeException
implements EndUserMessage

A custom runtime exception class that provides enhanced error details and user-friendly messages. It implements the EndUserMessage interface to support messages targeted at end users for better readability and clarity.

• Supports chaining of exceptions and integrates with the SOException class for consistent end-user messaging.
• Provides utility methods for extracting detailed stack traces and root cause analysis.
• Overridden methods aim to produce structurally formatted messages derived from the exception hierarchy and root causes.

Author:

Syam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SORuntimeException()	Default constructor for the SORuntimeException class.
SORuntimeException(String message)	Constructs a new SORuntimeException instance with the specified detail message.
SORuntimeException(String message, Throwable cause)	Constructs a new SORuntimeException instance with the specified detail message and cause.
SORuntimeException(Throwable cause)	Constructs a new SORuntimeException instance with the specified cause.

Method Summary

Modifier and Type	Method	Description
protected String	getCustomMessage()	Retrieves a custom message associated with this exception.
String	getEndUserMessage()	Get the message.
String	getMessage()
String	getTrace()	Retrieves the full or partial stack trace of this exception or its root cause as a string.
static String	getTrace(Thread thread)	Retrieves the stack trace of the specified thread as a string.
static String	getTrace(Thread thread, String title)	Retrieves the stack trace of the specified thread as a string.
static String	getTrace(Throwable t)	Retrieves a string representation of the stack trace for the given Throwable.
static String	getTrace(Throwable t, boolean full)	Retrieves a string representation of the stack trace for a given Throwable.
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Details

SORuntimeException

public SORuntimeException()

Default constructor for the SORuntimeException class. This constructor initializes a new instance of the exception without any custom message or cause.

SORuntimeException

public SORuntimeException(String message)

Constructs a new SORuntimeException instance with the specified detail message.

Parameters:

message - the detail message that explains the reason for the exception

SORuntimeException

public SORuntimeException(Throwable cause)

Constructs a new SORuntimeException instance with the specified cause.

Parameters:

cause - the underlying cause of the exception, which can be null

SORuntimeException

public SORuntimeException(String message,
 Throwable cause)

Constructs a new SORuntimeException instance with the specified detail message and cause.

Parameters:

message - the detail message that provides additional context or explanation for the exception

cause - the underlying cause of the exception, typically another Throwable, which can be null

Method Details

getEndUserMessage

public String getEndUserMessage()

Description copied from interface: EndUserMessage

Get the message.

Specified by:

getEndUserMessage in interface EndUserMessage

Returns:

The message that is for the end-users to read.

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getCustomMessage

protected String getCustomMessage()

Retrieves a custom message associated with this exception. This method can be overridden by subclasses to provide specific custom messages based on the exception's context.

Returns:

the custom message as a string, or null if no custom message is provided

toString

public String toString()

Overrides:

toString in class Throwable

getTrace

public String getTrace()

Retrieves the full or partial stack trace of this exception or its root cause as a string. This method determines the trace based on whether this exception has a cause or not, and delegates to the getTrace(Throwable, boolean) method.

Returns:

a string representation of the stack trace, starting from either the root cause or this exception

getTrace

public static String getTrace(Throwable t)

Retrieves a string representation of the stack trace for the given Throwable. The stack trace may represent either the root cause or the specified exception depending on the implementation.

Parameters:

t - the Throwable whose stack trace needs to be retrieved; cannot be null

Returns:

a string representation of the stack trace for the specified Throwable

getTrace

public static String getTrace(Throwable t,
 boolean full)

Retrieves a string representation of the stack trace for a given Throwable. The representation can include either the full stack trace with all causes or only the root cause, based on the specified flag.

Parameters:

t - the Throwable whose stack trace needs to be retrieved; must not be null

full - a boolean flag indicating whether to include the full stack trace (true) or only the root cause (false)

Returns:

a string representation of the stack trace, either for the full exception chain or just the root cause, depending on the full parameter

getTrace

public static String getTrace(Thread thread)

Retrieves the stack trace of the specified thread as a string. The stack trace is prefixed with a default title "Stack Trace".

Parameters:

thread - the Thread whose stack trace needs to be retrieved; must not be null

Returns:

a string representation of the stack trace for the specified thread, prefixed with the default title

getTrace

public static String getTrace(Thread thread,
 String title)

Retrieves the stack trace of the specified thread as a string. The stack trace is prefixed with the given title.

Parameters:

thread - the Thread whose stack trace needs to be retrieved; must not be null

title - the title to display as the prefix of the stack trace; must not be null or empty

Returns:

a string representation of the stack trace for the specified thread, prefixed with the given title