htsjdk.samtools.util.Log Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2009 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package htsjdk.samtools.util;
import java.io.PrintStream;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import java.util.function.Supplier;
/**
* A wafer thin wrapper around System.err that uses var-args to make it
* much more efficient to call the logging methods in without having to
* surround every call site with calls to Log.isXXXEnabled(). All the methods on this
* class take a variable length list of arguments and, only if logging is enabled for
* the level and channel being logged to, will those arguments be toString()'d and
* appended together.
*
* @author Tim Fennell
*/
public final class Log {
/**
* Enumeration for setting log levels.
*/
public enum LogLevel {ERROR, WARNING, INFO, DEBUG}
private static LogLevel globalLogLevel = LogLevel.INFO;
private static PrintStream out = System.err;
private final Class clazz;
private final String className;
/**
* Private constructor
*/
private Log(final Class clazz) {
this.clazz = clazz;
this.className = clazz.getSimpleName();
}
/**
* Get a Log instance to perform logging within the Class specified. Returns an instance
* of this class which wraps an instance of the commons logging Log class.
*
* @param clazz the Class which is going to be doing the logging
* @return a Log instance with which to log
*/
public static Log getInstance(final Class clazz) {
return new Log(clazz);
}
/**
* Set the log level.
*
* @param logLevel The log level enumeration
*/
public static void setGlobalLogLevel(final LogLevel logLevel) {
globalLogLevel = logLevel;
}
/**
* Get the log level.
*
* @return The enumeration for setting log levels.
*/
public static LogLevel getGlobalLogLevel() {
return globalLogLevel;
}
/**
* Set the {@link PrintStream} for writing.
*
* @param stream {@link PrintStream} to write to.
*/
public static void setGlobalPrintStream(final PrintStream stream) {
out = stream;
}
/**
* Get the {@link PrintStream} for writing.
*
* @return {@link PrintStream} to write to.
*/
public static PrintStream getGlobalPrintStream() {
return out;
}
/**
* Returns true if the specified log level is enabled otherwise false.
*/
public static final boolean isEnabled(final LogLevel level) {
return level.ordinal() <= globalLogLevel.ordinal();
}
/**
* Private method that does the actual printing of messages to a PrintWriter. Outputs the log level,
* class name and parts followed by the stack trace if a throwable is provided.
*
* @param level the Log level being logged at
* @param throwable a Throwable if one is available otherwise null
* @param parts the parts of the message to be concatenated
*/
private void emit(final LogLevel level, final Throwable throwable, final Object... parts) {
if (isEnabled(level)) {
final StringBuffer tmp = new StringBuffer();
tmp.append(level.name())
.append('\t')
.append(getTimestamp())
.append('\t')
.append(this.className)
.append('\t');
for (final Object part : parts) {
if (part != null && part.getClass().isArray()) {
final Class component = part.getClass().getComponentType();
if (component.equals(Boolean.TYPE)) {
tmp.append(Arrays.toString((boolean[]) part));
} else if (component.equals(Byte.TYPE)) {
tmp.append(Arrays.toString((byte[]) part));
} else if (component.equals(Character.TYPE)) {
tmp.append(Arrays.toString((char[]) part));
} else if (component.equals(Double.TYPE)) {
tmp.append(Arrays.toString((double[]) part));
} else if (component.equals(Float.TYPE)) {
tmp.append(Arrays.toString((float[]) part));
} else if (component.equals(Integer.TYPE)) {
tmp.append(Arrays.toString((int[]) part));
} else if (component.equals(Long.TYPE)) {
tmp.append(Arrays.toString((long[]) part));
} else if (component.equals(Short.TYPE)) {
tmp.append(Arrays.toString((short[]) part));
} else {
tmp.append(Arrays.toString((Object[]) part));
}
} else {
tmp.append(part);
}
}
// Print out the exception if there is one
if (throwable != null) {
synchronized (this.out) {
this.out.println(tmp.toString());
throwable.printStackTrace(this.out);
}
} else {
this.out.println(tmp.toString());
}
}
}
/**
* Creates a date string for insertion into the log. Given that logs are sometimes held statically
* and SimpleDateFormat is not thread safe, currently creates an instance each time :/
*/
protected String getTimestamp() {
final DateFormat fmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
return fmt.format(new Date());
}
/**
* Logs a Throwable and optional message parts at level error.
*
* @param throwable an instance of Throwable that should be logged with stack trace
* @param messageParts zero or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void error(final Throwable throwable, final Object... messageParts) {
emit(LogLevel.ERROR, throwable, messageParts);
}
/**
* Logs a Throwable and optional message parts at level warn.
*
* @param throwable an instance of Throwable that should be logged with stack trace
* @param messageParts zero or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void warn(final Throwable throwable, final Object... messageParts) {
emit(LogLevel.WARNING, throwable, messageParts);
}
/**
* Logs a Throwable and optional message parts at level info.
*
* @param throwable an instance of Throwable that should be logged with stack trace
* @param messageParts zero or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void info(final Throwable throwable, final Object... messageParts) {
emit(LogLevel.INFO, throwable, messageParts);
}
/**
* Logs a Throwable and optional message parts at level debug.
*
* @param throwable an instance of Throwable that should be logged with stack trace
* @param messageParts zero or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void debug(final Throwable throwable, final Object... messageParts) {
emit(LogLevel.DEBUG, throwable, messageParts);
}
// Similar methods, but without Throwables, follow
/**
* Logs one or more message parts at level error.
*
* @param messageParts one or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void error(final Object... messageParts) {
emit(LogLevel.ERROR, null, messageParts);
}
/**
* Logs one or more message parts at level warn.
*
* @param messageParts one or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void warn(final Object... messageParts) {
emit(LogLevel.WARNING, null, messageParts);
}
/**
* Logs one or more message parts at level info.
*
* @param messageParts one or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void info(final Object... messageParts) {
emit(LogLevel.INFO, null, messageParts);
}
/**
* Logs one or more message parts at level debug.
*
* @param messageParts one or more objects which should be combined, by calling toString()
* to form the log message.
*/
public final void debug(final Object... messageParts) {
emit(LogLevel.DEBUG, null, messageParts);
}
// Similar methods, but with Suppliers, follow. These enable avoiding generating the message
// if the logging level is such that the message will be dropped.
private final void getAndEmitIfEnabled(LogLevel logLevel, final Supplier