OnConsoleStatusListener.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 ch.qos.logback.core.Context;

import java.io.PrintStream;

/**
 * Print all new incoming status messages on the console (System.out).
 *
 * @author Ceki Gülcü
 */
public class OnConsoleStatusListener extends OnPrintStreamStatusListenerBase {

  @Override
  protected PrintStream getPrintStream() {
    return System.out;
  }

  /**
   * This utility method adds a new OnConsoleStatusListener to the context of
   * the contextAware object passed as parameter.
   *
   * @param loggerContext
   * @since 1.0.1
   */
  static public void addNewInstanceToContext(Context loggerContext) {

    OnConsoleStatusListener onConsoleStatusListener = new OnConsoleStatusListener();
    onConsoleStatusListener.setContext(loggerContext);
    boolean result = loggerContext.getStatusManager().addUniquely(onConsoleStatusListener, loggerContext);

    // start only if registered successfully. This check avoids superfluous
    // printing on the console.
    if (result)
      onConsoleStatusListener.start();
  }


}