universum.studios.android.util

Class ErrorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

universum.studios.android.util.ErrorException

All Implemented Interfaces:

Serializable

public class ErrorException
extends RuntimeException

A RuntimeException implementation that may be used to dispatch errors occurred during normal execution. A specific error can be identified by its code that can be supplied to each of constructors provided by this exception class. The specified error code can be than obtained via getCode().

This exception implementation supports also other common exception related parameters like message and cause.

Author:

Martin Albedinsky

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ErrorException(int code) Same as ErrorException(int, String) with empty message.
ErrorException(int code, String message) Same as ErrorException(int, String, Throwable) with null throwable cause.
ErrorException(int code, String message, Throwable cause) Creates a new instance of ErrorException with the specified error code, message and cause.
ErrorException(int code, Throwable cause) Same as ErrorException(int, String, Throwable) with empty message.

Method Summary

Modifier and Type	Method and Description
int	getCode() Returns the error code specified for this error exception.
static ErrorException	withCode(int code) Creates a new instance of ErrorException with the specified error code.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorException

public ErrorException(int code)

Same as ErrorException(int, String) with empty message.

ErrorException

public ErrorException(int code,
                      @Nullable
                      String message)

Same as ErrorException(int, String, Throwable) with null throwable cause.

ErrorException

public ErrorException(int code,
                      @Nullable
                      Throwable cause)

Same as ErrorException(int, String, Throwable) with empty message.

ErrorException

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

Creates a new instance of ErrorException with the specified error code, message and cause.

Parameters:

code - The desired error code for the error exception.

message - The desired message for the error exception. May be null.

cause - The desired throwable cause for the error exception. May be null.

Method Detail

withCode

@NonNull
public static ErrorException withCode(int code)

Creates a new instance of ErrorException with the specified error code.

Parameters:

code - The desired error code with which to create the error exception.

Returns:

New ErrorException with the specified error code.

getCode

public final int getCode()

Returns the error code specified for this error exception.

Returns:

This exception's error code.