001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core;
018
019/**
020 * Appenders may delegate their error handling to <code>ErrorHandlers</code>.
021 * @doubt if the appender interface is simplified, then error handling could just be done by wrapping
022 *  a nested appender. (RG) Please look at DefaultErrorHandler. It's purpose is to make sure the console
023 * or error log isn't flooded with messages. I'm still considering the Appender refactoring.
024 */
025public interface ErrorHandler {
026
027    /**
028     * Handle an error with a message.
029     * @param msg The message.
030     */
031    void error(String msg);
032
033    /**
034     * Handle an error with a message and an exception.
035     * @param msg The message.
036     * @param t The Throwable.
037     */
038    void error(String msg, Throwable t);
039
040    /**
041     * Handle an error with a message, and exception and a logging event.
042     * @param msg The message.
043     * @param event The LogEvent.
044     * @param t The Throwable.
045     */
046    void error(String msg, LogEvent event, Throwable t);
047}