Package jmri.util.swing

Class ExceptionContext

java.lang.Object

jmri.util.swing.ExceptionContext

Direct Known Subclasses:

UnexpectedExceptionContext

public class ExceptionContext
extends Object

Wraps an Exception and allows extra contextual information to be added, such as what was happening at the time of the Exception, and a hint as to what the user might do to correct the problem. Also implements a number of methods to format the data of an Exception.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Throwable	exception
protected String	hint
protected String	operation
protected String	prefaceString

Constructor Summary

Constructors

Constructor	Description
ExceptionContext(Throwable ex, String operation, String hint)	Create a new Exception Context.

Method Summary

Modifier and Type	Method	Description
String	getClipboardString(boolean includeSysInfo)	Get a String form of this Context for use in pasting to Clipboard.
Throwable	getException()	Get the Exception being wrapped.
String	getHint()	Get suggestion to the user to correct the problem.
String	getOperation()	Get what was happening when the exception occurred.
String	getPreface()	Used to give a more friendly message.
String	getStackTraceAsString(int maxLevels)	Returns up to the given number of stack trace elements concatenated into one string.
String	getStackTraceString()	Get the Full Stack Trace String.
String	getSummary()	Returns a user friendly summary of the Exception.
String	getTitle()	Get a String to use as the Title for this Context.

Methods inherited from class java.lang.Object

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

Field Details

exception

protected final Throwable exception

prefaceString

protected String prefaceString

operation

protected String operation

hint

protected String hint

Constructor Details

ExceptionContext

public ExceptionContext(@Nonnull
 Throwable ex,
 @Nonnull
 String operation,
 @Nonnull
 String hint)

Create a new Exception Context.

Parameters:

ex - the Throwable Exception which has occurred.

operation - An Operation which was taking place at the time of the Exception. Use empty String if unknown.

hint - A hint as to what might have caused the Exception. Use empty String if unknown.

Method Details

getException

public Throwable getException()

Get the Exception being wrapped.

Returns:

the Exception.

getPreface

public String getPreface()

Used to give a more friendly message.

Returns:

the Preface String.

getOperation

public String getOperation()

Get what was happening when the exception occurred.

Returns:

empty String if unknown.

getHint

@Nonnull
public String getHint()

Get suggestion to the user to correct the problem.

Returns:

empty string if no hint, else the hint text.

getTitle

public String getTitle()

Get a String to use as the Title for this Context.

Returns:

Localised Exception message, truncated to 80 chars.

getSummary

public String getSummary()

Returns a user friendly summary of the Exception. Empty data is excluded.

Returns:

A string summary.

getStackTraceAsString

public String getStackTraceAsString(int maxLevels)

Returns up to the given number of stack trace elements concatenated into one string.

Parameters:

maxLevels - The number of stack trace elements to return.

Returns:

A string stack trace.

getStackTraceString

public String getStackTraceString()

Get the Full Stack Trace String.

Returns:

unabridged Stack Trace String.

getClipboardString

public String getClipboardString(boolean includeSysInfo)

Get a String form of this Context for use in pasting to Clipboard.

Parameters:

includeSysInfo - true to include System Information, false for just the Exception details.

Returns:

String for use in Clipboard text.