Package org.apache.ignite.lang

Class IgniteCheckedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.ignite.lang.IgniteCheckedException

All Implemented Interfaces:

Serializable, TraceableException

public class IgniteCheckedException
extends Exception
implements TraceableException

General Ignite exception. Used to indicate any error condition within a node.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
IgniteCheckedException(int code)	Creates an exception with the given error code.
IgniteCheckedException(int code, @Nullable Throwable cause)	Creates an exception with the given error code and cause.
IgniteCheckedException(int code, String message)	Creates an exception with the given error code and detailed message.
IgniteCheckedException(int code, String message, @Nullable Throwable cause)	Creates an exception with the given error code, detailed message, and cause.
IgniteCheckedException(UUID traceId, int code)	Creates an exception with the given trace ID and error code.
IgniteCheckedException(UUID traceId, int code, @Nullable Throwable cause)	Creates an exception with the given trace ID, error code, and cause.
IgniteCheckedException(UUID traceId, int code, String message)	Creates an exception with the given trace ID, error code, and detailed message.
IgniteCheckedException(UUID traceId, int code, String message, @Nullable Throwable cause)	Creates an exception with the given trace ID, error code, detailed message, and cause.

Method Summary

Modifier and Type	Method	Description
int	code()	Returns a full error code that includes the error's group and code, which uniquely identifies the problem within the group.
String	codeAsString()	Returns a human-readable string that represents a full error code.
short	errorCode()	Returns an error code that uniquely identifies a problem within a group.
short	groupCode()	Returns an error group.
String	groupName()	Returns a group name of the error.
String	toString()
UUID	traceId()	Returns a unique identifier of the exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

IgniteCheckedException

public IgniteCheckedException(int code)

Creates an exception with the given error code.

Parameters:

code - Full error code.

IgniteCheckedException

public IgniteCheckedException(UUID traceId,
 int code)

Creates an exception with the given trace ID and error code.

Parameters:

traceId - Unique identifier of the exception.

code - Full error code.

IgniteCheckedException

public IgniteCheckedException(int code,
 String message)

Creates an exception with the given error code and detailed message.

Parameters:

code - Full error code.

message - Detailed message.

IgniteCheckedException

public IgniteCheckedException(UUID traceId,
 int code,
 String message)

Creates an exception with the given trace ID, error code, and detailed message.

Parameters:

traceId - Unique identifier of the exception.

code - Full error code.

message - Detailed message.

IgniteCheckedException

public IgniteCheckedException(int code,
 @Nullable
 @Nullable Throwable cause)

Creates an exception with the given error code and cause.

Parameters:

code - Full error code.

cause - Optional nested exception (can be null).

IgniteCheckedException

public IgniteCheckedException(UUID traceId,
 int code,
 @Nullable
 @Nullable Throwable cause)

Creates an exception with the given trace ID, error code, and cause.

Parameters:

traceId - Unique identifier of the exception.

code - Full error code.

cause - Optional nested exception (can be null).

IgniteCheckedException

public IgniteCheckedException(int code,
 String message,
 @Nullable
 @Nullable Throwable cause)

Creates an exception with the given error code, detailed message, and cause.

Parameters:

code - Full error code.

message - Detailed message.

cause - Optional nested exception (can be null).

IgniteCheckedException

public IgniteCheckedException(UUID traceId,
 int code,
 String message,
 @Nullable
 @Nullable Throwable cause)

Creates an exception with the given trace ID, error code, detailed message, and cause.

Parameters:

traceId - Unique identifier of the exception.

code - Full error code.

message - Detailed message.

cause - Optional nested exception (can be null).

Method Details

groupName

public String groupName()

Returns a group name of the error.

Returns:

Group name.

See Also:

• groupCode()
• code()

code

public int code()

Returns a full error code that includes the error's group and code, which uniquely identifies the problem within the group. This is a combination of two most-significant bytes for the error group and two least-significant bytes for the error code.

Specified by:

code in interface TraceableException

Returns:

Full error code.

codeAsString

public String codeAsString()

Returns a human-readable string that represents a full error code. The string format is 'IGN-XXX-nnn', where 'XXX' is the group name and 'nnn' is the unique error code within the group.

Returns:

Full error code in a human-readable format.

groupCode

public short groupCode()

Returns an error group.

Specified by:

groupCode in interface TraceableException

Returns:

Error group.

See Also:

• code()

errorCode

public short errorCode()

Returns an error code that uniquely identifies a problem within a group.

Specified by:

errorCode in interface TraceableException

Returns:

Error code.

See Also:

• code()
• groupCode()

traceId

public UUID traceId()

Returns a unique identifier of the exception.

Specified by:

traceId in interface TraceableException

Returns:

Unique identifier of the exception.

toString

public String toString()

Overrides:

toString in class Throwable