ch.qos.logback.core.rolling.TimeBasedFileNamingAndTriggeringPolicy Maven / Gradle / Ivy

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

import ch.qos.logback.core.rolling.helper.ArchiveRemover;
import ch.qos.logback.core.spi.ContextAware;

/**
 * This interface lists the set of methods that need to be implemented by
 * triggering policies which are nested within a {@link TimeBasedRollingPolicy}.
 * 
 * @author Ceki Gülcü
 * 
 * @param 
 */
public interface TimeBasedFileNamingAndTriggeringPolicy extends
    TriggeringPolicy, ContextAware {

  /**
   * Set the host/parent {@link TimeBasedRollingPolicy}.
   * 
   * @param the
   *                parent TimeBasedRollingPolicy
   */
  void setTimeBasedRollingPolicy(TimeBasedRollingPolicy tbrp);

  /**
   * Return the file name for the elapsed periods file name.
   * 
   * @return
   */
  String getElapsedPeriodsFileName();

  /**
   * Return the current periods file name without the compression suffix. This
   * value is equivalent to the active file name.
   * 
   * @return current period's file name (without compression suffix)
   */
  String getCurrentPeriodsFileNameWithoutCompressionSuffix();

  /**
   * Return the archive remover appropriate for this instance.
   */
  public ArchiveRemover getArchiveRemover();
  
  /**
   * Return the current time which is usually the value returned by
   * System.currentMillis(). However, for testing purposed this value
   * may be different than the real time.
   * 
   * @return current time value
   */
  long getCurrentTime();

  /**
   * Set the current time. Only unit tests should invoke this method.
   * 
   * @param now
   */
  void setCurrentTime(long now);

  /**
   * Set some date in the current period. Only unit tests should invoke this
   * method.
   * 
   * WARNING: method removed. A unit test should not set the
   * date in current period. It is the job of the FNATP to compute that.
   * 
   * @param date
   */
  //void setDateInCurrentPeriod(Date date); 
}