com.couchbase.lite.CouchbaseLiteException Maven / Gradle / Ivy

Go to download
//
// Copyright (c) 2020, 2017 Couchbase, Inc All rights reserved.
//
// Licensed 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 com.couchbase.lite;

import android.support.annotation.NonNull;
import android.support.annotation.Nullable;

import java.util.Map;

import com.couchbase.lite.internal.CBLInternalException;
import com.couchbase.lite.internal.core.CBLVersion;
import com.couchbase.lite.internal.support.Log;


/**
 * A CouchbaseLiteException gets raised whenever a Couchbase Lite faces errors.
 */
public final class CouchbaseLiteException extends Exception {
    static boolean isConflict(@Nullable CouchbaseLiteException err) {
        return (err != null)
            && CBLError.Domain.CBLITE.equals(err.getDomain())
            && (CBLError.Code.CONFLICT == err.getCode());
    }

    @NonNull
    private static String getErrorMessage(@Nullable String msg, @Nullable Exception e) {
        String errMsg = msg;

        if ((msg == null) && (e != null)) { errMsg = e.getMessage(); }

        return Log.lookupStandardMessage(errMsg) + "\n   (" + CBLVersion.getVersionInfo() + ")";
    }


    private final int code;
    @NonNull
    private final String domain;
    @Nullable
    private final Map info;

    /**
     * Constructs a new exception with the specified detail message.
     *
     * @param message the detail message.
     */
    public CouchbaseLiteException(@NonNull String message) { this(message, null, null, 0, null); }

    /**
     * Constructs a new exception with the specified cause
     *
     * @param cause the cause
     * @deprecated Must supply an error message
     */
    @Deprecated
    public CouchbaseLiteException(@NonNull Exception cause) { this(null, cause, null, 0, null); }

    /**
     * Constructs a new exception with the specified cause
     *
     * @param cause the cause
     */
    public CouchbaseLiteException(@NonNull String message, @NonNull Exception cause) {
        this(message, cause, null, 0, null);
    }

    /**
     * Constructs a new exception from an internal exception
     *
     * @param cause the internal exception
     * @deprecated Must supply an error message
     */
    @Deprecated
    public CouchbaseLiteException(@NonNull CBLInternalException cause) {
        this(null, cause, null, (cause == null) ? 0 : cause.getCode(), null);
    }

    /**
     * Constructs a new exception from an internal exception
     *
     * @param cause the internal exception
     */
    public CouchbaseLiteException(@NonNull String message, @NonNull CBLInternalException cause) {
        this(message, cause, null, (cause == null) ? 0 : cause.getCode(), null);
    }

    /**
     * Constructs a new exception with the specified error domain and error code
     *
     * @param domain the error domain
     * @param code   the error code
     * @deprecated Must supply an error message
     */
    @Deprecated
    public CouchbaseLiteException(@NonNull String domain, int code) { this(null, null, domain, code, null); }

    /**
     * Constructs a new exception with the specified detail message, error domain and error code
     *
     * @param message the detail message
     * @param domain  the error domain
     * @param code    the error code
     */
    public CouchbaseLiteException(@NonNull String message, @NonNull String domain, int code) {
        this(message, null, domain, code, null);
    }

    /**
     * Constructs a new exception with the specified error domain, error code and the specified cause
     *
     * @param domain the error domain
     * @param code   the error code
     * @param cause  the cause
     * @deprecated Must supply an error message
     */
    @Deprecated
    public CouchbaseLiteException(@NonNull String domain, int code, @NonNull Exception cause) {
        this(null, cause, domain, code, null);
    }

    /**
     * Constructs a new exception with the specified error domain, error code and the specified cause
     *
     * @param domain the error domain
     * @param code   the error code
     * @param info   the internal info map
     * @deprecated Must supply an error message
     */
    @Deprecated
    public CouchbaseLiteException(@NonNull String domain, int code, Map info) {
        this(null, null, domain, code, info);
    }

    /**
     * Constructs a new exception with the specified error domain, error code and the specified cause
     *
     * @param message the detail message
     * @param cause   the cause
     * @param domain  the error domain
     * @param code    the error code
     */
    public CouchbaseLiteException(
        @NonNull String message,
        @NonNull Exception cause,
        @NonNull String domain,
        int code) {
        this(message, cause, domain, code, null);
    }

    /**
     * This method is not part of the public API.
     * Do not use it.  It may change or disappear at any time.
     */
    public CouchbaseLiteException() { this(null, null, null, 0, null); }

    /**
     * This method is not part of the public API.
     * Do not use it.  It may change or disappear at any time.
     */
    public CouchbaseLiteException(
        @Nullable String message,
        @Nullable Exception cause,
        @Nullable String domain,
        int code,
        @Nullable Map info) {
        super(getErrorMessage(message, cause), cause);
        this.domain = (domain != null) ? domain : CBLError.Domain.CBLITE;
        this.code = (code > 0) ? code : CBLError.Code.UNEXPECTED_ERROR;
        this.info = info;
    }

    /**
     * Access the error domain for this error.
     *
     * @return The numerical domain code for this error.
     */
    @NonNull
    public String getDomain() { return domain; }

    /**
     * Access the error code for this error.
     *
     * @return The numerical error code for this error.
     */
    public int getCode() { return code; }

    @Nullable
    public Map getInfo() { return info; }

    @NonNull
    @Override
    public String toString() {
        final String msg = getMessage();
        return "CouchbaseLiteException{" + domain + "," + code + "," + ((msg == null) ? "" : ("'" + msg + "'")) + "}";
    }
}