com.itranswarp.jxrest

Class ApiException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.itranswarp.jxrest.ApiException

All Implemented Interfaces:

Serializable

public class ApiException
extends RuntimeException

Root exception for REST API with error code, error data and detailed message.

Author:

Michael Liao

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApiException(String code) Construct an ApiException using code.
ApiException(String code, String message) Construct an ApiException using code and message.
ApiException(String code, String data, String message) Construct an ApiException using code, data and message.

Method Summary

Modifier and Type	Method and Description
String	getCode() Get error code as string.
String	getData() Get error data as string.

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

ApiException

public ApiException(String code,
                    String data,
                    String message)

Construct an ApiException using code, data and message.

Parameters:

code - Error code as string.

data - Error data as string.

message - Error message as string.

ApiException

public ApiException(String code,
                    String message)

Construct an ApiException using code and message.

Parameters:

code - Error code as string.

message - Error message as string.

ApiException

public ApiException(String code)

Construct an ApiException using code.

Parameters:

code - Error code as string.

Method Detail

getCode

public String getCode()

Get error code as string.

Returns:

Error code as string.

getData

public String getData()

Get error data as string.

Returns:

Error data as string.