com.swirlds.logging.api.extensions.emergency.EmergencyLogger Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swirlds-logging Show documentation

Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.

There is a newer version: 0.56.5

Show newest version

/*
 * Copyright (C) 2023-2024 Hedera Hashgraph, LLC
 *
 * 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.swirlds.logging.api.extensions.emergency;

import com.swirlds.logging.api.Level;
import com.swirlds.logging.api.extensions.event.LogEvent;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;

/**
 * This interface is used to log emergency events. It is used in the logger api to log events. An implementation must
 * not be dependend on any other logging system and must be directly usable in the logger api. Next to that an
 * implementation must be bullet proof and must not throw any exceptions.
 */
public interface EmergencyLogger {

    /**
     * Logs a null pointer exception.
     *
     * @param nameOfNullParam the name of the null parameter
     */
    void logNPE(@NonNull String nameOfNullParam);

    /**
     * Logs an event.
     *
     * @param event the event to log
     */
    void log(@NonNull LogEvent event);

    /**
     * Logs a message.
     *
     * @param level   the level of the message
     * @param message the message to log
     */
    default void log(@NonNull final Level level, @NonNull final String message) {
        log(level, message, null);
    }

    /**
     * Logs a message with a throwable.
     *
     * @param level   the level of the message
     * @param message the message to log
     * @param thrown  the throwable to log
     */
    void log(@NonNull Level level, @NonNull String message, @Nullable Throwable thrown);
}