org.hkijena.jipipe.api.exceptions

Class UserFriendlyRuntimeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.hkijena.jipipe.api.exceptions.UserFriendlyRuntimeException

All Implemented Interfaces:

Serializable, UserFriendlyException

public class UserFriendlyRuntimeException
extends RuntimeException
implements UserFriendlyException

A RuntimeException that contains more detailed information for users. It answers in understandable terms: (1) What happened (2) Where it happened (3) Why it happened, and (4) What to do to resolve the issue

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserFriendlyRuntimeException(String message, String userWhat, String userWhere, String userWhy, String userHow)
UserFriendlyRuntimeException(String message, Throwable cause, String userWhat, String userWhere, String userWhy, String userHow)
UserFriendlyRuntimeException(Throwable cause, String userWhat, String userWhere, String userWhy, String userHow)

Method Summary

Modifier and Type	Method and Description
String	getUserHow()
String	getUserWhat()
String	getUserWhere()
String	getUserWhy()
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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 Detail

UserFriendlyRuntimeException

public UserFriendlyRuntimeException(String message,
                                    Throwable cause,
                                    String userWhat,
                                    String userWhere,
                                    String userWhy,
                                    String userHow)

Parameters:

message - the developer message

cause - the underlying exception

userWhat - the message for the user

userWhere - location of the exception

userWhy - explanation why it happened

userHow - explanation how to resolve the issue

UserFriendlyRuntimeException

public UserFriendlyRuntimeException(String message,
                                    String userWhat,
                                    String userWhere,
                                    String userWhy,
                                    String userHow)

Parameters:

message - the developer message

userWhat - the message for the user

userWhere - location of the exception

userWhy - explanation why it happened

userHow - explanation how to resolve the issue

UserFriendlyRuntimeException

public UserFriendlyRuntimeException(Throwable cause,
                                    String userWhat,
                                    String userWhere,
                                    String userWhy,
                                    String userHow)

Parameters:

cause - the underlying exception

userWhat - the message for the user

userWhere - location of the exception

userWhy - explanation why it happened

userHow - explanation how to resolve the issue

Method Detail

getUserWhat

public String getUserWhat()

Specified by:

getUserWhat in interface UserFriendlyException

getUserWhy

public String getUserWhy()

Specified by:

getUserWhy in interface UserFriendlyException

getUserHow

public String getUserHow()

Specified by:

getUserHow in interface UserFriendlyException

toString

public String toString()

Overrides:

toString in class Throwable

getUserWhere

public String getUserWhere()

Specified by:

getUserWhere in interface UserFriendlyException