io.geekidea.springbootplus.common.api

Enum ApiCode

java.lang.Object

java.lang.Enum<ApiCode>

io.geekidea.springbootplus.common.api.ApiCode

All Implemented Interfaces:

Serializable, Comparable<ApiCode>

public enum ApiCode
extends Enum<ApiCode>

REST API 响应码

Since:

2018-11-08

Author:

geekidea

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTHENTICATION_EXCEPTION
BUSINESS_EXCEPTION
DAO_EXCEPTION
FAIL
HTTP_MEDIA_TYPE_EXCEPTION
LOGIN_EXCEPTION
NOT_FOUND
NOT_PERMISSION
PARAMETER_EXCEPTION
PARAMETER_PARSE_EXCEPTION
SPRING_BOOT_PLUS_EXCEPTION
SUCCESS
SYSTEM_EXCEPTION
UNAUTHENTICATED_EXCEPTION
UNAUTHORIZED
UNAUTHORIZED_EXCEPTION
VERIFICATION_CODE_EXCEPTION

Method Summary

Modifier and Type	Method and Description
static ApiCode	getApiCode(int code)
int	getCode()
String	getMsg()
static ApiCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApiCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final ApiCode SUCCESS

UNAUTHORIZED

public static final ApiCode UNAUTHORIZED

NOT_PERMISSION

public static final ApiCode NOT_PERMISSION

NOT_FOUND

public static final ApiCode NOT_FOUND

FAIL

public static final ApiCode FAIL

LOGIN_EXCEPTION

public static final ApiCode LOGIN_EXCEPTION

SYSTEM_EXCEPTION

public static final ApiCode SYSTEM_EXCEPTION

PARAMETER_EXCEPTION

public static final ApiCode PARAMETER_EXCEPTION

PARAMETER_PARSE_EXCEPTION

public static final ApiCode PARAMETER_PARSE_EXCEPTION

HTTP_MEDIA_TYPE_EXCEPTION

public static final ApiCode HTTP_MEDIA_TYPE_EXCEPTION

SPRING_BOOT_PLUS_EXCEPTION

public static final ApiCode SPRING_BOOT_PLUS_EXCEPTION

BUSINESS_EXCEPTION

public static final ApiCode BUSINESS_EXCEPTION

DAO_EXCEPTION

public static final ApiCode DAO_EXCEPTION

VERIFICATION_CODE_EXCEPTION

public static final ApiCode VERIFICATION_CODE_EXCEPTION

AUTHENTICATION_EXCEPTION

public static final ApiCode AUTHENTICATION_EXCEPTION

UNAUTHENTICATED_EXCEPTION

public static final ApiCode UNAUTHENTICATED_EXCEPTION

UNAUTHORIZED_EXCEPTION

public static final ApiCode UNAUTHORIZED_EXCEPTION

Method Detail

values

public static ApiCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ApiCode c : ApiCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ApiCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getApiCode

public static ApiCode getApiCode(int code)

getCode

public int getCode()

getMsg

public String getMsg()