org.anchoranalysis.core.exception.friendly

Class AnchorFriendlyCheckedException

Object

Throwable

Exception

AnchorCheckedException

AnchorFriendlyCheckedException

All Implemented Interfaces:

Serializable, HasFriendlyErrorMessage

Direct Known Subclasses:

AssignPermutationException, AxisConversionException, BeanMisconfiguredException, BeanXMLException, BindFailedException, CheckException, CreateException, CSVReaderException, DefineAddException, DerivePathException, ExperimentExecutionException, FilesProviderException, FindFilesException, GetOperationFailedException, ImageIOException, ImageJConversionException, IncorrectImageSizeException, InitializeException, InvalidPathArgumentException, JobExecutionException, KernelCalculateEnergyException, NamedFeatureCalculateException, OperationFailedException, OptimizationTerminatedEarlyException, OutputWriteFailedException, PathDifferenceException, PathPrefixerException, ProposalAbnormalFailureException, ProposerException, ProvisionFailedException, ReporterException, SegmentationFailedException, SuggestionFormatException, SummaryException

public abstract class AnchorFriendlyCheckedException
extends AnchorCheckedException
implements HasFriendlyErrorMessage

A base class for particular checked-exceptions which are guaranteed to provide a user-friendly error description.

See the counterpart AnchorFriendlyRuntimeException.

Author:

Owen Feehan

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnchorFriendlyCheckedException(String message) A user-friendly error message WITHOUT a cause.
protected	AnchorFriendlyCheckedException(String message, Throwable cause) A user-friendly error message and its cause.
protected	AnchorFriendlyCheckedException(Throwable cause) A wrapped exception.

Method Summary

Modifier and Type	Method and Description
String	friendlyMessage() A friendly message to describe to the user what went wrong.
String	friendlyMessageHierarchy() A friendly message to describe to the user what went wrong, which doesn't impose a fixed-size, or showExceptionNames
void	friendlyMessageHierarchy(Writer writer, int wordWrapLimit, boolean showExceptionNames) A friendly message to describe to the user what went wrong, including all nested exceptions that have a non-empty error message
String	stackTrace() Prints a stack trace of the current exception to a string.

Methods inherited from class Throwable

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

Methods inherited from class Object

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

Constructor Detail

AnchorFriendlyCheckedException

protected AnchorFriendlyCheckedException(String message,
                                         Throwable cause)

A user-friendly error message and its cause. The message is displayed to the user.

Parameters:

message - a user-friendly error message to display to the user indicating the problem.

cause - the cause of the error.

AnchorFriendlyCheckedException

protected AnchorFriendlyCheckedException(String message)

A user-friendly error message WITHOUT a cause. This exception is displayed to the user. There are no more nested-errors possible.

Parameters:

message - a message describing the error.

AnchorFriendlyCheckedException

protected AnchorFriendlyCheckedException(Throwable cause)

A wrapped exception. We skip it in error reports

Parameters:

cause - the cause of the error

Method Detail

friendlyMessage

public String friendlyMessage()

Description copied from interface: HasFriendlyErrorMessage

A friendly message to describe to the user what went wrong. If no message has been defined in this exception, we keep iterating the hierarchy until we find a message

Specified by:

friendlyMessage in interface HasFriendlyErrorMessage

Returns:

a string describing what went wrong

friendlyMessageHierarchy

public String friendlyMessageHierarchy()

Description copied from interface: HasFriendlyErrorMessage

A friendly message to describe to the user what went wrong, which doesn't impose a fixed-size, or showExceptionNames

Specified by:

friendlyMessageHierarchy in interface HasFriendlyErrorMessage

Returns:

a string (often multi-lined) describing a hierarchy of errors that occurred

friendlyMessageHierarchy

public void friendlyMessageHierarchy(Writer writer,
                                     int wordWrapLimit,
                                     boolean showExceptionNames)
                              throws IOException

Description copied from interface: HasFriendlyErrorMessage

A friendly message to describe to the user what went wrong, including all nested exceptions that have a non-empty error message

It starts the least-most-nested exception. It ends with the further-most-nested exception (cause).

Specified by:

friendlyMessageHierarchy in interface HasFriendlyErrorMessage

Parameters:

writer - where the friendly-messaged is outputted

wordWrapLimit - a fixed-width size for the message and indentation (ignoring the exception name). -1 disables.

showExceptionNames - show exception-names after the error output

Throws:

IOException - if an I/O error occurs with the writer

stackTrace

public String stackTrace()

Prints a stack trace of the current exception to a string.

Returns:

a string describing the stack trace of the exception.