org.pmw.tinylog.labelers.Labeler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tinylog Show documentation

Lightweight logging framework for Java and Android

There is a newer version: 1.3.6

/*
 * Copyright 2012 Martin Winandy
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package org.pmw.tinylog.labelers;

import java.io.File;
import java.io.IOException;

import org.pmw.tinylog.Configuration;

/**
 * A labeler names log files and backups for {@link org.pmw.tinylog.writers.RollingFileWriter RollingFileWriter}.
 *
 * 
 * The annotation {@link org.pmw.tinylog.labelers.PropertiesSupport PropertiesSupport} must be added to the implemented
 * labeler class and the implemented labeler must be registered as service in
 * "META-INF/services/org.pmw.tinylog.labelers" in order to make the labeler available by properties files and system
 * properties.
 * 
 *
 * 
 * Example:

 * 
 * {@literal @}PropertiesSupport(name = "count")

 * public final class CountLabeler implements Labeler {
 * 
 * 
 *
 * 
 * A labeler must have a default constructor without any parameters. Optionally it can have an additional constructor
 * with a string parameter if the labeler supports parameters.
 * 
 */
public interface Labeler {

	/**
	 * Initialize the labeler.
	 *
	 * @param configuration
	 *            Configuration of logger
	 */
	void init(Configuration configuration);

	/**
	 * Returns the real log file.
	 *
	 * @param baseFile
	 *            Defined log file by user
	 * @return Real log file
	 */
	File getLogFile(File baseFile);

	/**
	 * Rolls existing log files and backups and returns a new log file.
	 *
	 * @param file
	 *            Current log file
	 * @param maxBackups
	 *            Maximum number of backups to store
	 * @return New log file
	 *
	 * @throws IOException
	 *             Failed to roll log file
	 */
	File roll(File file, int maxBackups) throws IOException;

}