org.sonar.api.utils

Class MessageException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.sonar.api.utils.MessageException

All Implemented Interfaces:

Serializable

public class MessageException
extends RuntimeException

Runtime exception for "functional" error. It aims to be displayed to end-users, without any technical information like stack traces.
It's handling depends on the versions of the sonar-batch and sonar-runner. sonar-runner 2.4 will only show the message associated with this exception. Starting from sonar-batch 5.3, this is handled in the batch side, and the main goal is to hide all wrappers of this exception. If this exception is created without cause, then only the message associated with this exception is shown; otherwise, its causes are also shown. Previous combinations of sonar-batch/sonar-runner log all stack trace.
Message should be clear and complete. Keep in mind that context might not be added to the exception. Names of processed resource and decorator are for example not automatically added when throwing MessageException from Decorator.

Since:

3.7.1

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
Throwable	fillInStackTrace() Does not fill in the stack trace
String	l10nKey()
Collection<Object>	l10nParams()
static MessageException	of(String message)
static MessageException	of(String message, Throwable cause)
static MessageException	ofL10n(String l10nKey, Object... l10nParams)
String	toString()

Methods inherited from class java.lang.Throwable

addSuppressed, 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

Method Detail

of

public static MessageException of(String message,
                                  Throwable cause)

of

public static MessageException of(String message)

ofL10n

public static MessageException ofL10n(String l10nKey,
                                      Object... l10nParams)

fillInStackTrace

public Throwable fillInStackTrace()

Does not fill in the stack trace

Overrides:

fillInStackTrace in class Throwable

See Also:

Throwable.fillInStackTrace()

toString

public String toString()

Overrides:

toString in class Throwable

l10nKey

@CheckForNull
public String l10nKey()

l10nParams

@CheckForNull
public Collection<Object> l10nParams()