Package io.github.venkateshamurthy.exceptional.exceptions

Interface ExceptionCode

public interface ExceptionCode

An interface to model exception code, short description and enable creating CommonRuntimeException

Field Summary

Fields

Modifier and Type	Field	Description
static final Throwable	NULL_CAUSE	Null Throwable used while building exception not requiring the cause.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Short description of the error.
default org.springframework.http.HttpStatus	getStatus()	Get http status.
String	name()	Short name of the error/exception code.
default CommonRuntimeException	toCommonRTE()	A CommonRuntimeException generator given getDescription() serving as a message.
default CommonRuntimeException	toCommonRTE(String message)	A CommonRuntimeException generator given a message.
default CommonRuntimeException	toCommonRTE(String template, Object... args)	Deprecated, for removal: This API element is subject to removal in a future version. in favour of toCommonRTE(Throwable, String, String, Object...).
default CommonRuntimeException	toCommonRTE(String message, String template, Object... args)	A CommonRuntimeException creator given message, details template and args
default CommonRuntimeException	toCommonRTE(String template, Map<String,Object> args)	Deprecated, for removal: This API element is subject to removal in a future version. in favour oftoCommonRTE(Throwable, String, String, Object...).
default CommonRuntimeException	toCommonRTE(Throwable cause, String message)	A CommonRuntimeException generator given a cause and message.
default CommonRuntimeException	toCommonRTE(Throwable cause, String message, String template, Object... args)	A CommonRuntimeException creator given cause, message, details template and args
default CommonRuntimeException	toCommonRTE(MessageFormat template, Object... args)	Deprecated, for removal: This API element is subject to removal in a future version. in favour of toCommonRTE(Throwable, String, String, Object...).Please do not use this

Field Details

NULL_CAUSE

static final Throwable NULL_CAUSE

Null Throwable used while building exception not requiring the cause.

Method Details

name

String name()

Short name of the error/exception code.

Returns:

name/code of the error.

getDescription

String getDescription()

Short description of the error.

Returns:

description.

getStatus

default org.springframework.http.HttpStatus getStatus()

Get http status.

Returns:

HttpStatus

toCommonRTE

default CommonRuntimeException toCommonRTE()

A CommonRuntimeException generator given getDescription() serving as a message. This exception should be further updated with detailed message to have all the contextual details.

Returns:

CommonRuntimeException

toCommonRTE

default CommonRuntimeException toCommonRTE(String message)

A CommonRuntimeException generator given a message. This exception should be further updated with detailed message to have all the contextual details.

Parameters:

message - for Exception

Returns:

CommonRuntimeException

toCommonRTE

default CommonRuntimeException toCommonRTE(Throwable cause,
 String message)

A CommonRuntimeException generator given a cause and message. This exception should be further updated with detailed message to have all the contextual details.

Parameters:

cause - the original cause of the error to be set within this exception.

message - for Exception

Returns:

CommonRuntimeException

toCommonRTE

default CommonRuntimeException toCommonRTE(String message,
 String template,
 Object... args)

A CommonRuntimeException creator given message, details template and args

Parameters:

message - the exception message

template - the details message template

args - the arguments (either could be just one Map of key-value or var-args)

Returns:

CommonRuntimeException

toCommonRTE

default CommonRuntimeException toCommonRTE(Throwable cause,
 String message,
 String template,
 Object... args)

A CommonRuntimeException creator given cause, message, details template and args

Parameters:

cause - the original cause of the error to be set within this exception

message - the exception message

template - the details message template

args - the arguments (either could be just one Map of key-value or var-args)

Returns:

CommonRuntimeException

toCommonRTE

@Deprecated(since="1.5",
            forRemoval=true)
default CommonRuntimeException toCommonRTE(String template,
 Object... args)

Deprecated, for removal: This API element is subject to removal in a future version.

in favour of toCommonRTE(Throwable, String, String, Object...). Please do not use this

A CommonRuntimeException generator setting the message of getDescription()

Parameters:

template - a SLF4J style formatted template (for eg: "Server error:{}") where placeholders to be substituted.

args - the parameters are stringifiable var-args to be used to replace each placeholder template

Returns:

CommonRuntimeException

toCommonRTE

@Deprecated(since="1.5",
            forRemoval=true)
default CommonRuntimeException toCommonRTE(String template,
 Map<String,Object> args)

Deprecated, for removal: This API element is subject to removal in a future version.

in favour oftoCommonRTE(Throwable, String, String, Object...). Please do not use this

A CommonRuntimeException with message using getDescription() along with detailed map of parameters.

Parameters:

template - for a detailed message that needs variable interpolated based on substitution markers

args - the parameters to be used to replace the markered template

Returns:

CommonRuntimeException

toCommonRTE

@Deprecated(since="1.5",
            forRemoval=true)
default CommonRuntimeException toCommonRTE(MessageFormat template,
 Object... args)

Deprecated, for removal: This API element is subject to removal in a future version.

in favour of toCommonRTE(Throwable, String, String, Object...).Please do not use this

A CommonRuntimeException generator given

Parameters:

template - a formatted detailed message that would be processed by MessageFormat

args - the parameters to be used to replace the markers supported by MessageFormat

Returns:

CommonRuntimeException