io.atomix.copycat.error

Interface CopycatError

All Known Implementing Classes:

CopycatError.Type

public interface CopycatError

Base type for Copycat protocol errors.

Copycat errors are passed on the wire in lieu of exceptions to reduce the overhead of serialization. Each error is identifiable by an error ID which is used to serialize and deserialize errors.

Author:

Jordan Halterman

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CopycatError.Type Raft error types.

Method Summary

Modifier and Type	Method and Description
CopycatException	createException() Creates a new exception for the error.
static CopycatError	forId(int id) Returns the Raft error for the given identifier.
byte	id() Returns the unique error identifier.

Method Detail

forId

static CopycatError forId(int id)

Returns the Raft error for the given identifier.

Parameters:

id - The Raft error identifier.

Returns:

The Raft error for the given identifier.

Throws:

IllegalArgumentException - If the given identifier is not a valid Raft error identifier.

id

byte id()

Returns the unique error identifier.

Returns:

The unique error identifier.

createException

CopycatException createException()

Creates a new exception for the error.

Returns:

The error exception.