ch.qos.logback.core.spi.AppenderAttachable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/**
 * 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ü
 *
 * @deprecated This internal logback API is not supported by AEM as a Cloud Service.
 */
@Deprecated(since = "2022-01-27")
public interface AppenderAttachable {

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

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

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

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

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

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

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