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 
18 package org.apache.log4j.spi;
19 
20 import org.apache.log4j.Appender;
21 import java.util.Enumeration;
22 
23 /**
24    Interface for attaching appenders to objects.
25 
26    @author Ceki Gülcü
27    @since 0.9.1 */
28 public interface AppenderAttachable {
29 
30   /**
31      Add an appender.
32    */
33   public
addAppender(Appender newAppender)34   void addAppender(Appender newAppender);
35 
36   /**
37      Get all previously added appenders as an Enumeration.  */
38   public
getAllAppenders()39   Enumeration getAllAppenders();
40 
41   /**
42      Get an appender by name.
43    */
44   public
getAppender(String name)45   Appender getAppender(String name);
46 
47 
48   /**
49      Returns <code>true</code> if the specified appender is in list of
50      attached attached, <code>false</code> otherwise.
51 
52      @since 1.2 */
53   public
isAttached(Appender appender)54   boolean isAttached(Appender appender);
55 
56   /**
57      Remove all previously added appenders.
58   */
removeAllAppenders()59   void removeAllAppenders();
60 
61 
62   /**
63      Remove the appender passed as parameter from the list of appenders.
64   */
removeAppender(Appender appender)65    void removeAppender(Appender appender);
66 
67 
68  /**
69     Remove the appender with the name passed as parameter from the
70     list of appenders.
71   */
72  void
removeAppender(String name)73  removeAppender(String name);
74 }
75 
76