io.openmessaging.api.exception.OMSRuntimeException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmessaging-api Show documentation
There is a newer version: 2.2.1-pubsub
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package io.openmessaging.api.exception;

import io.openmessaging.api.OMSResponseStatus;

/**
 * This is the root class of all unchecked 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.
 * 
 *
 * @version OMS 1.1.0
 * @since OMS 1.1.0
 */
public class OMSRuntimeException extends RuntimeException {

    /**
     * Vendor-specific error code
     *
     * @see Error
     **/
    private int errorCode;

    public OMSRuntimeException() {
    }

    public OMSRuntimeException(String message) {
        super(message);
        this.errorCode = OMSResponseStatus.STATUS_1400.getStatusCode();
    }

    public OMSRuntimeException(Throwable cause) {
        super(cause);
        this.errorCode = OMSResponseStatus.STATUS_1400.getStatusCode();
    }

    public OMSRuntimeException(String message, Throwable cause) {
        super(message, cause);
        this.errorCode = OMSResponseStatus.STATUS_1400.getStatusCode();
    }

    /**
     * Constructs a {@code OMSRuntimeException} with the specified detail message and error code.
     *
     * @param errorCode a specified error code
     * @param message a description of the exception
     **/
    public OMSRuntimeException(int errorCode, String message) {
        super(message);
        this.errorCode = errorCode;
    }

    /**
     * Constructs a {@code OMSRuntimeException} with the specified error code and cause.
     *
     * @param errorCode a specified error code
     * @param cause the underlying cause of this exception
     */
    public OMSRuntimeException(int errorCode, Throwable cause) {
        super(cause);
        this.errorCode = errorCode;
    }

    /**
     * Constructs a {@code OMSRuntimeException} with the specified detail message, error code and cause.
     *
     * @param errorCode a specified error code
     * @param message a description of the exception
     * @param cause the underlying cause of this exception
     */
    public OMSRuntimeException(int errorCode, String message, Throwable cause) {
        super(message, cause);
        this.errorCode = errorCode;
    }

    /**
     * Returns the error code of this {@code OMSRuntimeException} object.
     *
     * @return the error code
     */
    public int getErrorCode() {
        return errorCode;
    }
}