io.realm

Enum ErrorCode

java.lang.Object

java.lang.Enum<ErrorCode>

io.realm.ErrorCode

All Implemented Interfaces:

Serializable, Comparable<ErrorCode>

public enum ErrorCode
extends Enum<ErrorCode>

This class enumerate all potential errors related to using the Object Server or synchronizing data.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ErrorCode.Category

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCESS_DENIED
BAD_AUTHENTICATION
BAD_CHANGESET
BAD_CLIENT_FILE_IDENT
BAD_CLIENT_VERSION
BAD_MESSAGE_ORDER
BAD_SERVER_FILE_IDENT
BAD_SERVER_VERSION
BAD_SESSION_IDENT
BAD_SYNTAX
BOUND_IN_OTHER_SESSION
CLIENT_RESET
CONNECTION_CLOSED
DISABLED_SESSION
DIVERGING_HISTORIES
EXISTING_ACCOUNT
EXPIRED_REFRESH_TOKEN
ILLEGAL_REALM_PATH
INVALID_CREDENTIALS
INVALID_PARAMETERS
IO_EXCEPTION
JSON_EXCEPTION
LIMITS_EXCEEDED
MISSING_PARAMETERS
NO_SUCH_PATH
OTHER_ERROR
OTHER_SESSION_ERROR
PERMISSION_DENIED
REUSE_OF_SESSION_IDENT
SESSION_CLOSED
TOKEN_EXPIRED
UNKNOWN
UNKNOWN_ACCOUNT
UNKNOWN_MESSAGE
WRONG_PROTOCOL_VERSION

Method Summary

Modifier and Type	Method and Description
static ErrorCode	fromException(Exception exception) Helper method for mapping between Exception and ErrorCode.
static ErrorCode	fromInt(int errorCode)
ErrorCode.Category	getCategory() Returns the getCategory of the error.
int	intValue() Returns the numerical value for this error code.
String	toString()
static ErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final ErrorCode UNKNOWN

IO_EXCEPTION

public static final ErrorCode IO_EXCEPTION

JSON_EXCEPTION

public static final ErrorCode JSON_EXCEPTION

CLIENT_RESET

public static final ErrorCode CLIENT_RESET

CONNECTION_CLOSED

public static final ErrorCode CONNECTION_CLOSED

OTHER_ERROR

public static final ErrorCode OTHER_ERROR

UNKNOWN_MESSAGE

public static final ErrorCode UNKNOWN_MESSAGE

BAD_SYNTAX

public static final ErrorCode BAD_SYNTAX

LIMITS_EXCEEDED

public static final ErrorCode LIMITS_EXCEEDED

WRONG_PROTOCOL_VERSION

public static final ErrorCode WRONG_PROTOCOL_VERSION

BAD_SESSION_IDENT

public static final ErrorCode BAD_SESSION_IDENT

REUSE_OF_SESSION_IDENT

public static final ErrorCode REUSE_OF_SESSION_IDENT

BOUND_IN_OTHER_SESSION

public static final ErrorCode BOUND_IN_OTHER_SESSION

BAD_MESSAGE_ORDER

public static final ErrorCode BAD_MESSAGE_ORDER

SESSION_CLOSED

public static final ErrorCode SESSION_CLOSED

OTHER_SESSION_ERROR

public static final ErrorCode OTHER_SESSION_ERROR

TOKEN_EXPIRED

public static final ErrorCode TOKEN_EXPIRED

BAD_AUTHENTICATION

public static final ErrorCode BAD_AUTHENTICATION

ILLEGAL_REALM_PATH

public static final ErrorCode ILLEGAL_REALM_PATH

NO_SUCH_PATH

public static final ErrorCode NO_SUCH_PATH

PERMISSION_DENIED

public static final ErrorCode PERMISSION_DENIED

BAD_SERVER_FILE_IDENT

public static final ErrorCode BAD_SERVER_FILE_IDENT

BAD_CLIENT_FILE_IDENT

public static final ErrorCode BAD_CLIENT_FILE_IDENT

BAD_SERVER_VERSION

public static final ErrorCode BAD_SERVER_VERSION

BAD_CLIENT_VERSION

public static final ErrorCode BAD_CLIENT_VERSION

DIVERGING_HISTORIES

public static final ErrorCode DIVERGING_HISTORIES

BAD_CHANGESET

public static final ErrorCode BAD_CHANGESET

DISABLED_SESSION

public static final ErrorCode DISABLED_SESSION

INVALID_PARAMETERS

public static final ErrorCode INVALID_PARAMETERS

MISSING_PARAMETERS

public static final ErrorCode MISSING_PARAMETERS

INVALID_CREDENTIALS

public static final ErrorCode INVALID_CREDENTIALS

UNKNOWN_ACCOUNT

public static final ErrorCode UNKNOWN_ACCOUNT

EXISTING_ACCOUNT

public static final ErrorCode EXISTING_ACCOUNT

ACCESS_DENIED

public static final ErrorCode ACCESS_DENIED

EXPIRED_REFRESH_TOKEN

public static final ErrorCode EXPIRED_REFRESH_TOKEN

Method Detail

values

public static ErrorCode[] 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 (ErrorCode c : ErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ErrorCode 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

toString

public String toString()

Overrides:

toString in class Enum<ErrorCode>

intValue

public int intValue()

Returns the numerical value for this error code.

Returns:

the error code as an unique int value.

getCategory

public ErrorCode.Category getCategory()

Returns the getCategory of the error.

Errors come in 2 categories: FATAL, RECOVERABLE

FATAL: The session cannot be recovered and needs to be re-created. A likely cause is that the User does not have access to this Realm. Check that the SyncConfiguration is correct.

RECOVERABLE: Temporary error. The session will automatically try to recover as soon as possible.

Returns:

the severity of the error.

fromInt

public static ErrorCode fromInt(int errorCode)

fromException

public static ErrorCode fromException(Exception exception)

Helper method for mapping between Exception and ErrorCode.

Parameters:

exception - to be mapped as an ErrorCode.

Returns:

mapped ErrorCode.