org.biffle.cliff.pearl
Class FailureException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--org.biffle.cliff.pearl.PearlException
                    |
                    +--org.biffle.cliff.pearl.FailureException

All Implemented Interfaces:

java.io.Serializable

public class FailureException

extends PearlException

Thrown when a Pearl command returns a normal response with a failure status code. Generally, message failure should be handled gracefully, but this exception can be thrown if appropriate.

See Also:

Serialized Form

Field Summary

static int	AUTH_REQUIRED
static int	LOCK_REQUIRED
static int	NOT_FOUND
static int	PASSWORD_INCORRECT
static int	SUCCESS

Constructor Summary

FailureException(int status)
Creates a new FailureException, drawing a status code from a section of a byte array.

FailureException(java.lang.String msg, int status)
Creates a new FailureException with a message, drawing a status code from a section of a byte array.

Method Summary

int	getStatus()
static java.lang.String	statusString(int status)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

PASSWORD_INCORRECT

public static final int PASSWORD_INCORRECT

See Also:

Constant Field Values

LOCK_REQUIRED

public static final int LOCK_REQUIRED

See Also:

Constant Field Values

AUTH_REQUIRED

public static final int AUTH_REQUIRED

See Also:

Constant Field Values

NOT_FOUND

public static final int NOT_FOUND

See Also:

Constant Field Values

Constructor Detail

FailureException

public FailureException(int status)

Creates a new FailureException, drawing a status code from a section of a byte array. The status code is always four bytes, and FailureException does not verify the array bounds. You have been warned.

FailureException

public FailureException(java.lang.String msg,
                        int status)

Creates a new FailureException with a message, drawing a status code from a section of a byte array. The status code is always four bytes, and FailureException does not verify the array bounds. You have been warned.

Method Detail

statusString

public static java.lang.String statusString(int status)

getStatus

public int getStatus()