io.openmessaging.exception

Class OMSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

io.openmessaging.exception.OMSException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

OMSResourceNotExistException

public class OMSException
extends Exception

This is the root class of all checked exceptions in the OMS API.

A OMSException consists of the following parts:

• A provider-specific string describing the error.
• A provider-specific string error code to identify the specific exception type.

Since:

OMS 1.0.0

Version:

OMS 1.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMSException(String errorCode, String message) Constructs a OMSException with the specified detail message and error code.
OMSException(String errorCode, String message, Throwable cause) Constructs a OMSException with the specified detail message, error code and cause.
OMSException(String errorCode, Throwable cause) Constructs a OMSException with the specified error code and cause.

Method Summary

Modifier and Type	Method and Description
String	getErrorCode() Returns the error code of this OMSException object.

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

OMSException

public OMSException(String errorCode,
                    String message)

Constructs a OMSException with the specified detail message and error code.

Parameters:

errorCode - a specified error code

message - a description of the exception

OMSException

public OMSException(String errorCode,
                    Throwable cause)

Constructs a OMSException with the specified error code and cause.

Parameters:

errorCode - a specified error code

cause - the underlying cause of this exception

OMSException

public OMSException(String errorCode,
                    String message,
                    Throwable cause)

Constructs a OMSException with the specified detail message, error code and cause.

Parameters:

errorCode - a specified error code

message - a description of the exception

cause - the underlying cause of this exception

Method Detail

getErrorCode

public String getErrorCode()

Returns the error code of this OMSException object.

Returns:

the error code