pro.fessional.mirana.pain

Class CodeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

pro.fessional.mirana.pain.CodeException

All Implemented Interfaces:

Serializable, CodeAware, I18nAware

Direct Known Subclasses:

BadArgsException, BadStateException, CrudException, MessageException

public class CodeException
extends RuntimeException
implements I18nAware, CodeAware

Readability and performance first exception. always enable suppression and support tweak stacktrace. the tweaking priority is para, code, claz, elze, thread then global.

Since:

2019-05-29

Author:

trydofor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CodeException.TweakingCodeException tweaking stacktrace by code and thread

Nested classes/interfaces inherited from interface pro.fessional.mirana.i18n.I18nAware

I18nAware.I18nSource

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DefaultStack
static CodeException.TweakingCodeException	TweakStack

Constructor Summary

Constructors

Constructor and Description
CodeException(boolean stack, @NotNull CodeEnum code) Constructs a stacked or unstacked exception depending on the Global or Thread setting.
CodeException(boolean stack, @NotNull CodeEnum code, Object... args) Constructs a stacked or unstacked exception directly.
CodeException(boolean stack, @NotNull String code) Constructs a stacked or unstacked exception directly.
CodeException(boolean stack, @NotNull String code, String message) Constructs a stacked or unstacked exception depending on the Global or Thread setting.
CodeException(boolean stack, @NotNull String code, String message, Object... args) Constructs a stacked or unstacked exception directly.
CodeException(@NotNull CodeEnum code) Constructs a stacked or unstacked exception depending on the Global or Thread setting.
CodeException(@NotNull CodeEnum code, Object... args) Constructs a stacked or unstacked exception depending on the Global or Thread setting.
CodeException(@NotNull String code) Constructs a stacked or unstacked exception depending on the Global or Thread setting.
CodeException(@NotNull String code, String message) Constructs a stacked or unstacked exception depending on the Global or Thread setting.
CodeException(@NotNull String code, String message, Object... args) Constructs a stacked or unstacked exception directly.
CodeException(@NotNull Throwable cause, @NotNull CodeEnum code)
CodeException(@NotNull Throwable cause, @NotNull CodeEnum code, Object... args)
CodeException(@NotNull Throwable cause, @NotNull String code)
CodeException(@NotNull Throwable cause, @NotNull String code, String message)
CodeException(@NotNull Throwable cause, @NotNull String code, String message, Object... args)

Method Summary

Modifier and Type	Method and Description
void	applyLocale(Locale locale, @NotNull I18nAware.I18nSource source) apply the internal locale and updates the i18n state based on the provided source.
@NotNull String	getCode()
Object[]	getI18nArgs() the args of template
String	getI18nCode() the i18n code, also template id
String	getI18nHint() the default message or template (if no template by code)
String	getLocalizedMessage()
String	getMessage()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface pro.fessional.mirana.i18n.I18nAware

getI18nArgsIf, getI18nArgsOr, getI18nCodeIf, getI18nCodeOr, getI18nHintIf, getI18nHintOr, toI18nString, toI18nString, toI18nString, toString, toString, toString

Methods inherited from interface pro.fessional.mirana.data.CodeAware

getCodeIf, getCodeOr

Field Detail

DefaultStack

public static final boolean DefaultStack

See Also:

Constant Field Values

TweakStack

public static final CodeException.TweakingCodeException TweakStack

Constructor Detail

CodeException

public CodeException(boolean stack,
                     @NotNull
                     @NotNull String code,
                     String message,
                     Object... args)

Constructs a stacked or unstacked exception directly.

CodeException

public CodeException(@NotNull
                     @NotNull String code)

Constructs a stacked or unstacked exception depending on the Global or Thread setting.

CodeException

public CodeException(boolean stack,
                     @NotNull
                     @NotNull String code)

Constructs a stacked or unstacked exception directly.

CodeException

public CodeException(@NotNull
                     @NotNull String code,
                     String message)

Constructs a stacked or unstacked exception depending on the Global or Thread setting.

CodeException

public CodeException(boolean stack,
                     @NotNull
                     @NotNull String code,
                     String message)

Constructs a stacked or unstacked exception depending on the Global or Thread setting.

CodeException

public CodeException(@NotNull
                     @NotNull String code,
                     String message,
                     Object... args)

Constructs a stacked or unstacked exception directly.

CodeException

public CodeException(@NotNull
                     @NotNull CodeEnum code)

Constructs a stacked or unstacked exception depending on the Global or Thread setting.

CodeException

public CodeException(boolean stack,
                     @NotNull
                     @NotNull CodeEnum code)

Constructs a stacked or unstacked exception depending on the Global or Thread setting.

CodeException

public CodeException(@NotNull
                     @NotNull CodeEnum code,
                     Object... args)

Constructs a stacked or unstacked exception depending on the Global or Thread setting.

CodeException

public CodeException(boolean stack,
                     @NotNull
                     @NotNull CodeEnum code,
                     Object... args)

Constructs a stacked or unstacked exception directly.

CodeException

public CodeException(@NotNull
                     @NotNull Throwable cause,
                     @NotNull
                     @NotNull String code,
                     String message,
                     Object... args)

CodeException

public CodeException(@NotNull
                     @NotNull Throwable cause,
                     @NotNull
                     @NotNull String code)

CodeException

public CodeException(@NotNull
                     @NotNull Throwable cause,
                     @NotNull
                     @NotNull String code,
                     String message)

CodeException

public CodeException(@NotNull
                     @NotNull Throwable cause,
                     @NotNull
                     @NotNull CodeEnum code)

CodeException

public CodeException(@NotNull
                     @NotNull Throwable cause,
                     @NotNull
                     @NotNull CodeEnum code,
                     Object... args)

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getLocalizedMessage

public String getLocalizedMessage()

Overrides:

getLocalizedMessage in class Throwable

applyLocale

public void applyLocale(Locale locale,
                        @NotNull
                        @NotNull I18nAware.I18nSource source)

Description copied from interface: I18nAware

apply the internal locale and updates the i18n state based on the provided source.

Specified by:

applyLocale in interface I18nAware

Parameters:

locale - the locale to be applied

source - the i18n source providing the translations

getCode

@NotNull
public @NotNull String getCode()

Specified by:

getCode in interface CodeAware

getI18nHint

public String getI18nHint()

Description copied from interface: I18nAware

the default message or template (if no template by code)

Specified by:

getI18nHint in interface I18nAware

getI18nCode

public String getI18nCode()

Description copied from interface: I18nAware

the i18n code, also template id

Specified by:

getI18nCode in interface I18nAware

getI18nArgs

public Object[] getI18nArgs()

Description copied from interface: I18nAware

the args of template

Specified by:

getI18nArgs in interface I18nAware