snaq.util.logging.TerseFormatter Maven / Gradle / Ivy
/*
---------------------------------------------------------------------------
DBPool : Java Database Connection Pooling In a Java Logging configuration properties file:
*
* <handler>.formatter=snaq.util.logging.TerseFormatter
*
* NOTE: this class is NOT thread-safe.
*
* @author Giles Winstanley
* @deprecated This class may be removed in future, and users are encouraged to use SLF4J logging.
*/
@Deprecated
public class TerseFormatter extends SimpleFormatter
{
/** Platform line-separator. */
private final static String LSEP = System.getProperty("line.separator");
/** Date instance for re-use in date/time formatting. */
private final Date date = new Date();
/** {@code DateFormat} instance for date/time formatting. */
private DateFormat dateFormat;
/** Separator string (between log-entry info and log message). */
protected String separator;
/** Log entry formatting string. */
private String formatString;
/** Argument array for log entry message formatting. */
private final String args[] = new String[5];
/** Determines whether to show class names in log entries. */
private boolean showClass;
/** Determines whether to show short class names in log entries. */
private boolean showClassShort;
/** Determines whether to show method names in log entries. */
private boolean showMethod;
/** Determines whether to show levels in log entries. */
private boolean showLevel;
/**
* Creates a new TerseFormatter instance.
* @param showLevel whether to display log levels
* @param showClass whether to display class names
* @param showClassShort whether to display short class names (i.e. no package details)
* @param showMethod whether to display method names
*/
public TerseFormatter(boolean showLevel, boolean showClass, boolean showClassShort, boolean showMethod)
{
this.showLevel = showLevel;
this.showClass = showClass;
this.showClassShort = showClassShort;
this.showMethod = showMethod;
createFormatString();
// Default date format: ISO 8601
dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss,SSS");
}
/**
* Creates a new TerseFormatter instance.
* The created instance displays log levels.
* @param showClass whether to display class names
* @param showClassShort whether to display short class names (i.e. no package details)
* @param showMethod whether to display method names
*/
public TerseFormatter(boolean showClass, boolean showClassShort, boolean showMethod)
{
this(true, showClass, showClassShort, showMethod);
}
/**
* Creates a new TerseFormatter instance (all details displayed).
*/
public TerseFormatter()
{
this(true, false, false, false);
}
/**
* Sets the {@code DateFormat} instance to use for formatting log entries.
* @param df {@code DateFormat} instance to use
*/
public void setDateFormat(DateFormat df)
{
this.dateFormat = df;
}
/**
* @return {@code DateFormat} instance used for formatting log entries.
*/
public DateFormat getDateFormat()
{
return dateFormat;
}
/**
* Sets the separator string between the date and log message (default ": ").
* To set the default separator (": "), call with a null argument.
* @param sep string to use as separator
*/
public synchronized void setSeparator(String sep)
{
separator = sep;
createFormatString();
}
private void createFormatString()
{
StringBuilder sb = new StringBuilder();
sb.append("{0}");
if (showLevel)
sb.append(" {1}");
if (showClass)
{
sb.append(" ({2}");
if (showMethod)
sb.append("#{3}");
sb.append(" )");
}
sb.append(separator == null ? ": " : separator);
sb.append("{4}");
sb.append(LSEP);
formatString = sb.toString();
}
@Override
public String format(LogRecord record)
{
// Format date/time.
date.setTime(record.getMillis());
if (dateFormat == null)
dateFormat = DateFormat.getDateTimeInstance();
// Set values of argument for log entry formatting.
args[0] = dateFormat.format(date);
args[1] = record.getLevel().getLocalizedName();
if (showClass)
args[2] = record.getSourceClassName();
if (showMethod)
args[3] = record.getSourceMethodName().trim();
args[4] = formatMessage(record);
// Check for short class name.
if (showClassShort)
args[2] = args[2].substring(args[2].lastIndexOf('.') + 1);
// Create buffer to hold log entry message.
StringBuilder sb = new StringBuilder();
sb.append(MessageFormat.format(formatString, (Object[])args));
// Check for Throwable attached to log record.
if (record.getThrown() != null)
{
try
{
StringWriter sw = new StringWriter();
try (PrintWriter pw = new PrintWriter(sw))
{
record.getThrown().printStackTrace(pw);
}
sb.append(sw.toString());
}
catch (Exception ex)
{
ex.printStackTrace();
}
}
return sb.toString();
}
}