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 */ 017 package org.apache.logging.log4j.core; 018 019 import java.io.Serializable; 020 021 /** 022 * Appends log events. 023 * 024 * @param <T> The {@link Layout}'s {@link Serializable} type. 025 */ 026 public interface Appender<T extends Serializable> extends LifeCycle { 027 028 /** 029 * Log in <code>Appender</code> specific way. When appropriate, 030 * Loggers will call the <code>doAppend</code> method of appender 031 * implementations in order to log. 032 * 033 * @param event The LogEvent. 034 */ 035 void append(LogEvent event); 036 037 038 /** 039 * Get the name of this appender. 040 * 041 * @return name, may be null. 042 */ 043 String getName(); 044 045 /** 046 * Returns this appender's layout. 047 * 048 * @return the Layout for the Appender or null if none is configured. 049 */ 050 Layout<T> getLayout(); 051 052 /** 053 * If set to true any exceptions thrown by the Appender will be logged but not thrown. 054 * @return true if Exceptions should be suppressed, false otherwise. 055 */ 056 boolean isExceptionSuppressed(); 057 058 ErrorHandler getHandler(); 059 060 void setHandler(ErrorHandler handler); 061 062 }