Package io.github.venkateshamurthy.exceptional.exceptions

Interface ExceptionCode

public interface ExceptionCode

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

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(String message)	A CommonRuntimeException generator given
default CommonRuntimeException	toCommonRTE(String template, Object... args)	A CommonRuntimeException generator setting the message of getDescription()
default CommonRuntimeException	toCommonRTE(String message, MessageFormat template, Object... args)	A CommonRuntimeException generator given
default CommonRuntimeException	toCommonRTE(String template, Map<String,Object> args)	A CommonRuntimeException with message set with getDescription() with following other parameters.

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(String message)

A CommonRuntimeException generator given

Parameters:

message - for Exception

Returns:

CommonRuntimeException

toCommonRTE

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

A CommonRuntimeException generator setting the message of getDescription()

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

default CommonRuntimeException toCommonRTE(String template,
 Map<String,Object> args)

A CommonRuntimeException with message set with getDescription() with following other 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

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

A CommonRuntimeException generator given

Parameters:

message - for Exception

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