de.vandermeer.skb.interfaces.application

Interface ApplicationErrorCode

All Superinterfaces:

CategoryHas, HasDescription

public interface ApplicationErrorCode
extends HasDescription

An application error code.

Since:

v0.0.2

Version:

v0.0.2 build 170502 (02-May-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Method Summary

Modifier and Type	Method and Description
int	getArgs() Returns the number of expected arguments.
ErrorCodeCategory	getCategory() Returns the category of the error code.
int	getCode() Returns the error code.
String	getMessage() Returns the error message.
default String	getMessage(Object... args) Creates a new error message with all arguments substituted.

Methods inherited from interface HasDescription

getDescription

Method Detail

getCategory

ErrorCodeCategory getCategory()

Returns the category of the error code.

Returns:

error code category

getCode

int getCode()

Returns the error code.

Returns:

error code

getArgs

int getArgs()

Returns the number of expected arguments.

Returns:

number of expected arguments

getMessage

String getMessage()

Returns the error message.

Returns:

error message

getMessage

default String getMessage(Object... args)

Creates a new error message with all arguments substituted. The length of arguments must be equal to the number of expected arguments of this error code. If the number of expected arguments is 0, then args can be null or of length 0.

Parameters:

args - the arguments, must have same length as expected arguments

Returns:

new error message