de.frame4j.io

Class LogTextFormatter

java.lang.Object

java.util.logging.Formatter

de.frame4j.io.LogTextFormatter

@MinDoc(copyright="Copyright  2001 - 2002, 2009  A. Weinert",
        author="Albrecht Weinert",
        version="V.39",
        lastModified="17.04.2021",
        usage="use for (java.) logging",
        purpose="a formatter for log messages (as text)")
public class LogTextFormatter
extends Formatter

A logger formatter for the simple text form.

An object of this class is a plain efficient Formatter, suitable for the logging API's Handler like e.g. LogWriterHandler.
It transforms LogRecords into a simple human readable text format.

© Copyright 2006 Albrecht Weinert

Author:

Albrecht Weinert

See Also:

TextHelper, TimeHelper

Field Summary

Fields

Modifier and Type	Field and Description
protected String	head Header for this Formatter's output.
protected String	tail End text for this Formatter's output.
protected String	wedaclock (Nationalised) time format.

Constructor Summary

Constructors

Constructor and Description
LogTextFormatter(CharSequence head, CharSequence tail) Make a formatter (LogRecord -> Text).

Method Summary

Modifier and Type	Method and Description
String	format(LogRecord record) Formatting a LogRecord in readable text format.
String	formatMessage(LogRecord record) Formatting a message.
static StringBuilder	formatMessage(StringBuilder bastel, LogRecord record) Formatting a message.
String	getHead(Handler h) Header for this Formatter's output.
String	getTail(Handler h) End text for this Formatter's output.
String	getTimeFormat() (Nationalised) time format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

head

protected String head

Header for this Formatter's output.

tail

protected String tail

End text for this Formatter's output.

wedaclock

protected transient String wedaclock

(Nationalised) time format.

See Also:

getTimeFormat()

Constructor Detail

LogTextFormatter

public LogTextFormatter(CharSequence head,
                        CharSequence tail)

Make a formatter (LogRecord -> Text).

Method Detail

getHead

public String getHead(Handler h)

Header for this Formatter's output.

This method returns the sequence set on construction. (The parameter is ignored.)

default: ComVar.EMPTY_STRING

Overrides:

getHead in class Formatter

getTail

public String getTail(Handler h)

End text for this Formatter's output.

This method returns the sequence set on construction. (The parameter is ignored.)

default: ComVar.EMPTY_STRING

Overrides:

getTail in class Formatter

formatMessage

public static StringBuilder formatMessage(StringBuilder bastel,
                                          LogRecord record)

Formatting a message.

The LogRecord's (record's) message ) remains unchanged if null or empty. Otherwise it is tried to interpret it as a key for a language specific report or message format (AppLangMap.valueUL(message, message)).

If the — may be language specifically &mdasH; modified message is empty or contains no pattern "{0" .. "{9" (for formatting of parameters; see TextHelper.messageFormat(..)) it is returned as (now) is. The same applies if record has no or an empty parameter entry (LogRecord.getParameters()).

As a especialness this formatter replaces a pattern "{*} by the comma separated list of all parameters. If this pattern is there this will be the only parameter formatting made.

Otherwise message will be used as formatting pattern for TextHelper.messageFormat(..)) and the result will be returned.

Returning a result here means the appending to a StringBuilder supplied or newly generated.

Hint: This is the implementing / helper method for format(LogRecord).

Parameters:

record - the log entry with the plain (raw) message

bastel - the builder to append to. If null made with start capacity 99

Returns:

bastel

See Also:

AppLangMap, AppLangMap.valueUL(CharSequence, String)

formatMessage

public final String formatMessage(LogRecord record)

Formatting a message.

The call is equivalent to
formatMessage(null, record) returned as String.

Overrides:

formatMessage in class Formatter

getTimeFormat

public final String getTimeFormat()

(Nationalised) time format.

Never null.
default: AppLangMap.valueUL("wedaclock").

See Also:

TimeHelper.format(CharSequence, ZonedDateTime)

format

public String format(LogRecord record)

Formatting a LogRecord in readable text format.

The output is:
time, levelName [sequence], sourceClassName (or LoggerName as substitute), MethodName : \\
message(parameters if given)
Exception stack trace (if given)

Hint 1: time will formated as
day of week, date , time of day
using the standard nationalised formatting; for French one may see e.g. something like
je, 29.06.2006, 09:28:50

Hint 2: Logging applications should take the sense to supply a unique source object's / actor's name instead of class or method names usually expected, supported or even determined at immense costs (by "helper exceptions") by logging APIs.

That logging APIs (including the Java-Logging-API) don't see that as use case stems from the fact that those logging APIs are all being designed in reality as debugging — software event collecting — APIs for the sake of the programmer and not as logging support for say process control applications.

Specified by:

format in class Formatter

Parameters:

record - the log entry with the plain (raw) message

Returns:

record's content human readable (may be multi-line)