StatusManager.java

/**
 * Logback: the reliable, generic, fast and flexible logging framework.
 * Copyright (C) 1999-2013, 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.status;

import java.util.List;

/**
 * Internal error messages (statii) are managed by instances of this interface.
 *
 * @author Ceki Gulcu
 */
public interface StatusManager {

  /**
   * Add a new status message.
   *
   * @param status the status to add
   */
  void add(Status status);

  /**
   * Obtain a copy of the status list maintained by this StatusManager.
   *
   * @return the status list
   */
  List<Status> getCopyOfStatusList();

  /**
   * Return the highest level of all the statii.
   *
   * @return
   */
  //int getLevel();

  /**
   * Return the number of status entries.
   *
   * @return entry count
   */
  int getCount();

  /**
   * Add a status listener.
   * @param listener the status listener
   */
  void add(StatusListener listener);


  /**
   * Add a status listener unless another instance of the same type has been
   * previously registered.
   *
   * @param listener the status listener
   * @param origin the caller of this method
   * @return true if the listener has been registered, false otherwise
   */
  boolean addUniquely(StatusListener listener, Object origin);


  /**
   * Remove a status listener.
   *
   * @param listener the status listener
   */
  void remove(StatusListener listener);


  /**
   * Clear the list of status messages.
   */
  void clear();


  /**
   * Obtain a copy of the status listener list maintained by this StatusManager
   *
   * @return the status listener list
   */
  List<StatusListener> getCopyOfStatusListenerList();

}