com.mooltiverse.oss.nyx.entities.Verbosity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java Show documentation
com.mooltiverse.oss.nyx:java:3.0.6 All the Nyx Java artifacts
The newest version!
/*
 * Copyright 2020 Mooltiverse
 *
 * 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.mooltiverse.oss.nyx.entities;

import java.util.Objects;

import org.slf4j.event.Level;

/**
 * This class maps log {@link Level}s and the corresponding configuration options and state attributes,
 * whose string representations may not always match the {@link Level} values.
 * 
 * In other words, here is the mapping between logging levels and the string values users can use in configuration
 * and state to ask for those logging levels.
 */
public enum Verbosity {
    /**
     * The fatal log level. Please note that this level has no corresponding level into SLF4J
     * so the value is the same as {@link #ERROR}.
     * 
     * @see Level#ERROR
     */
    FATAL(Level.ERROR),

    /**
     * The error log level.
     * 
     * @see Level#ERROR
     */
    ERROR(Level.ERROR),

    /**
     * The warning log level.
     * 
     * @see Level#WARN
     */
    WARNING(Level.WARN),

    /**
     * The info log level.
     * 
     * @see Level#INFO
     */
    INFO(Level.INFO),

    /**
     * The debug log level.
     * 
     * @see Level#DEBUG
     */
    DEBUG(Level.DEBUG),

    /**
     * The trace log level.
     * 
     * @see Level#TRACE
     */
    TRACE(Level.TRACE);

    /**
     * The SLF4J corresponding logging level.
     */
    private final Level level;

    /**
     * Builds the enumeration item.
     * 
     * @param level the SLF4J corresponding logging level
     */
    private Verbosity(Level level) {
        this.level = level;
    }

    /**
     * Returns the SLF4J level corresponding to this verbosity level
     * 
     * @return the SLF4J level corresponding to this verbosity level
     */
    public Level getLevel() {
        return level;
    }

    /**
     * Returns the proper verbosity level mapped from the given SLF4J level.
     * 
     * @param level the SLF4J level to parse and return the verbosity for
     * 
     * @return the proper verbosity level mapped from the given SLF4J level.
     * 
     * @throws IllegalArgumentException if the given value cannot be mapped to any existing verbosity level
     * @throws NullPointerException if the given value is {@code null}
     */
    public static Verbosity fromLevel(Level level)
        throws IllegalArgumentException, NullPointerException {
        if (Objects.isNull(level))
            throw new NullPointerException();

        switch (level) {
            case TRACE: return Verbosity.TRACE;
            case DEBUG: return Verbosity.DEBUG;
            case INFO:  return Verbosity.INFO;
            case WARN:  return Verbosity.WARNING;
            case ERROR: return Verbosity.ERROR;
            default: throw new IllegalArgumentException(level.toString());
        }
    }
}