io.github.awidesky.guiUtil.Logger Maven / Gradle / Ivy
/*
* Copyright (c) 2023 Eugene Hong
*
* This software is distributed under license. Use of this software
* implies agreement with all terms and conditions of the accompanying
* software license.
* Please refer to LICENSE
* */
package io.github.awidesky.guiUtil;
import java.io.Closeable;
import java.text.DateFormat;
/**
* The interface for a Logger object.
*
* @author Eugene Hong
* */
public interface Logger extends Closeable, AutoCloseable {
/**
* A pre-constructed simple logger object that just prints to console
* */
public static final Logger consoleLogger = new AbstractLogger() {
{
setPrefix("[ConsoleLogger] ");
}
@Override
public void newLine() {
System.out.println();
}
@Override
public void log(String data) {
System.out.println(getPrefix() + data);
}
@Override
public void close() {}
};
/**
* Set date information prefix for this Logger instance.
* if argument is null, no date information prefix is appended.
* Date prefix is always appended very first of the line.
* */
public void setDatePrefix(DateFormat datePrefix);
/**
* Set additional prefix for this Logger instance.
* if argument is null, no additional prefix is appended.
* The additional prefix is always appended after date prefix(if exists).
*
* @see Logger#setDatePrefix(DateFormat)
* */
public void setPrefix(String prefix);
/**
* Print a new line without printing any prefixes.
* */
public void newLine();
/**
* Logs a String.
* */
public void log(String data);
/**
* Logs an Exception .
* */
public void log(Exception e);
/**
* Logs an array of Objects.
* */
public void log(Object... objs);
/**
* Set verbosity of this Logger object.
* */
public void setVerbose(boolean verbose);
/**
* Get verbosity of this Logger object.
* */
public boolean isVerbose();
/**
* Log in verbose mode.
* If this.verbose is true, argument data is logged, otherwise it doesn't.
*
* @see Logger#setVerbose(boolean)
* */
public void logVerbose(String data);
}