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

Go to download
//
// Copyright (c) 2020, 2019 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 java.util.EnumMap;

import com.couchbase.lite.internal.core.C4Constants;
import com.couchbase.lite.internal.support.Log;


/**
 * Log level.
 */
public enum LogLevel {

    /**
     * Debug log messages. Only present in debug builds of CouchbaseLite.
     */
    DEBUG(C4Constants.LogLevel.DEBUG),

    /**
     * Verbose log messages.
     */
    VERBOSE(C4Constants.LogLevel.VERBOSE),

    /**
     * Informational log messages.
     */
    INFO(C4Constants.LogLevel.INFO),

    /**
     * Warning log messages.
     */
    WARNING(C4Constants.LogLevel.WARNING),

    /**
     * Error log messages. These indicate immediate errors that need to be addressed.
     */
    ERROR(C4Constants.LogLevel.ERROR),

    /**
     * Disabling log messages of a given log domain.
     */
    NONE(C4Constants.LogLevel.NONE);


    private static final EnumMap LEVELS = new EnumMap<>(LogLevel.class);

    static {
        LEVELS.put(DEBUG, "D");
        LEVELS.put(VERBOSE, "V");
        LEVELS.put(INFO, "I");
        LEVELS.put(WARNING, "W");
        LEVELS.put(ERROR, "E");
        LEVELS.put(NONE, "");
    }

    private final int value;

    LogLevel(int value) { this.value = value; }

    /**
     * !!! This should not be part if the Public API.  The number that it returns
     * is never useful to client software and begs confusion with the integer
     * log level used by Android, to which it is completely unrelated.
     *
     * @return the CBL internal representation of the log level
     */
    public int getValue() { return value; }

    @Override
    public String toString() {
        final String s = LEVELS.get(this);
        if (s != null) { return s; }
        Log.d(LogDomain.DATABASE, "Unknown log level: " + this);
        return "?";
    }
}