au.id.jericho.lib.html.BasicLogFormatter Maven / Gradle / Ivy
// Jericho HTML Parser - Java based library for analysing and manipulating HTML
// Version 2.6
// Copyright (C) 2007 Martin Jericho
// http://jerichohtml.sourceforge.net/
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of either one of the following licences:
//
// 1. The Eclipse Public License (EPL) version 1.0,
// included in this distribution in the file licence-epl-1.0.html
// or available at http://www.eclipse.org/legal/epl-v10.html
//
// 2. The GNU Lesser General Public License (LGPL) version 2.1 or later,
// included in this distribution in the file licence-lgpl-2.1.txt
// or available at http://www.gnu.org/licenses/lgpl.txt
//
// This library is distributed on an "AS IS" basis,
// WITHOUT WARRANTY OF ANY KIND, either express or implied.
// See the individual licence texts for more details.
package au.id.jericho.lib.html;
import java.util.logging.*;
/**
* Provides basic formatting for log messages.
*
* This class extends the java.util.logging.Formatter class, allowing it to be specified as a formatter for the java.util.logging system.
*
* The static {@link #format(String level, String message, String loggerName)} method provides a means of using the same formatting
* outside of the java.util.logging framework. See the documentation of this method for more details.
*/
public class BasicLogFormatter extends Formatter {
/**
* Determines whether the logging level is included in the output.
*
* The default value is true.
*
* As this is a static property, changing the value will affect all BasicLogFormatter instances, as well as the behaviour of the
* static {@link #format(String level, String message, String loggerName)} method.
*/
public static boolean OutputLevel=true;
/**
* Determines whether the logger name is included in the output.
*
* The default value is false.
*
* The logger name used for all automatically created {@link Logger} instances is "net.htmlparser.jericho".
*
* As this is a static property, changing the value will affect all BasicLogFormatter instances, as well as the behaviour of the
* static {@link #format(String level, String message, String loggerName)} method.
*/
public static boolean OutputName=false;
static final Formatter INSTANCE=new BasicLogFormatter();
/**
* Returns a formatted string representing the log entry information contained in the specified java.util.logging.LogRecord.
*
* This method is not called directly, but is used by the java.util.logging framework when this class is specified
* as a formatter in the logging.properties file.
*
* See the documentation of the parent java.util.logging.Formatter class in the Java SDK for more details.
*
* @param logRecord a java.util.logging.LogRecord object containing all of the log entry information.
* @return a formatted string representing the log entry information contained in the specified java.util.logging.LogRecord.
*/
public String format(final LogRecord logRecord) {
return format(logRecord.getLevel().getName(),logRecord.getMessage(),logRecord.getLoggerName());
}
/**
* Returns a formatted string representing the specified log entry information.
*
* This method is used by the default implementation of the {@link WriterLogger#log(String level, String message)} method.
*
* The static properties {@link #OutputLevel} and {@link #OutputName} affect what information is included in the output.
*
* The static {@link Config#NewLine} property determines the character sequence used for line breaks.
*
* A line of output typically looks like this:
*
INFO: this is the log message
* or if the {@link #OutputName} property is set to true, the output would look similar to this:
* INFO: [net.htmlparser.jericho] this is the log message
*
* @param level a string representing the logging level of the log entry.
* @param message the log message.
* @param loggerName the name of the logger.
* @return a formatted string representing the specified log entry information.
*/
public static String format(final String level, final String message, final String loggerName) {
final StringBuffer sb=new StringBuffer(message.length()+40);
if (OutputLevel) sb.append(level).append(": ");
if (OutputName && loggerName!=null) sb.append('[').append(loggerName).append("] ");
sb.append(message);
sb.append(Config.NewLine);
return sb.toString();
}
}