View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core;
18  
19  import java.io.Serializable;
20  
21  /**
22   * Appends log events.
23   *
24   * @param <T> The {@link Layout}'s {@link Serializable} type.
25   */
26  public interface Appender<T extends Serializable> extends LifeCycle {
27  
28      /**
29       * Log in <code>Appender</code> specific way. When appropriate,
30       * Loggers will call the <code>doAppend</code> method of appender
31       * implementations in order to log.
32       *
33       * @param event The LogEvent.
34       */
35      void append(LogEvent event);
36  
37  
38      /**
39       * Get the name of this appender.
40       *
41       * @return name, may be null.
42       */
43      String getName();
44  
45      /**
46       * Returns this appender's layout.
47       *
48       * @return the Layout for the Appender or null if none is configured.
49       */
50      Layout<T> getLayout();
51  
52      /**
53       * If set to true any exceptions thrown by the Appender will be logged but not thrown.
54       * @return true if Exceptions should be suppressed, false otherwise.
55       */
56      boolean isExceptionSuppressed();
57  
58      ErrorHandler getHandler();
59  
60      void setHandler(ErrorHandler handler);
61  
62  }