http://logback.qos.ch/logback-core: logback-core module (QOS.ch)
  • Ceki Gulcu
  • Joern Huxhorn 
Logback: the reliable, generic, fast and flexible logging framework.
Copyright (C) 1999-2015, QOS.ch. All rights reserved.
This program and the accompanying materials are dual-licensed under
either the terms of the Eclipse Public License v1.0 as published by
the Eclipse Foundation
  or (per the licensee's choosing)
under the terms of the GNU Lesser General Public License version 2.1
as published by the Free Software Foundation.

/**
 * Logback: the reliable, generic, fast and flexible logging framework.
 * Copyright (C) 1999-2015, QOS.ch. All rights reserved.
 *
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *
 *   or (per the licensee's choosing)
 *
 * under the terms of the GNU Lesser General Public License version 2.1
 * as published by the Free Software Foundation.
 */
package ch.qos.logback.core.spi;

import java.util.Iterator;

import ch.qos.logback.core.Appender;


Interface for attaching appenders to objects.

Author:Ceki Gülcü
/**
 * Interface for attaching appenders to objects.
 * 
 * @author Ceki Gülcü
 */
public interface AppenderAttachable<E> {
    
Add an appender.

/**
     * Add an appender.
     */
    void addAppender(Appender<E> newAppender);

    
Get an iterator for appenders contained in the parent object.

/**
     * Get an iterator for appenders contained in the parent object.
     */
    Iterator<Appender<E>> iteratorForAppenders();

    
Get an appender by name.

/**
     * Get an appender by name.
     */
    Appender<E> getAppender(String name);

    
Returns true if the specified appender is in list of
attached attached, false otherwise.

/**
     * Returns <code>true</code> if the specified appender is in list of
     * attached attached, <code>false</code> otherwise.
     */
    boolean isAttached(Appender<E> appender);

    
Detach and processPriorToRemoval all previously added appenders.

/**
     * Detach and processPriorToRemoval all previously added appenders.
     */
    void detachAndStopAllAppenders();

    
Detach the appender passed as parameter from the list of appenders.

/**
     * Detach the appender passed as parameter from the list of appenders.
     */
    boolean detachAppender(Appender<E> appender);

    
Detach the appender with the name passed as parameter from the list of
appenders.

/**
     * Detach the appender with the name passed as parameter from the list of
     * appenders.
     */
    boolean detachAppender(String name);
}