Package org.tinylog.core

Class TinylogLoggingConfiguration

java.lang.Object

org.tinylog.core.TinylogLoggingConfiguration

public class TinylogLoggingConfiguration
extends Object

Configuration support for a logging provider which uses writers for the actual logging. Supports creating writers, general provider configuration and a creation of a LogEntry for writers.

Constructor Summary

Constructors

Constructor	Description
TinylogLoggingConfiguration()

Method Summary

Modifier and Type	Method	Description
protected void	addWriter(Writer writer, Collection<Writer>[][] matrix, int tagIndex, org.tinylog.Level level)	Adds a writer to a well-defined matrix.
BitSet	calculateFullStackTraceRequirements(Collection<LogEntryValue>[][] logEntryValues)	Calculates for which tag a full stack trace element with method name, file name and line number is required.
org.tinylog.Level	calculateMinimumLevel(org.tinylog.Level globalLevel, Map<String,org.tinylog.Level> customLevels)	Calculates the minimum severity level that can output any log entries.
Collection<LogEntryValue>[][]	calculateRequiredLogEntryValues(Collection<Writer>[][] writers)	Creates a matrix with all required log entry values for each tag and severity level.
static LogEntry	createLogEntry(StackTraceElement stackTraceElement, String tag, org.tinylog.Level level, Throwable exception, org.tinylog.format.MessageFormatter formatter, Object obj, Object[] arguments, Collection<LogEntryValue>[] requiredLogEntryValues, org.tinylog.provider.ContextProvider contextProvider)	Creates a new log entry.
Collection<Writer>[][]	createWriters(List<String> tags, org.tinylog.Level minimumLevel, boolean writingThread)	Creates a two-dimensional matrix with all configured writers.
WritingThread	createWritingThread(Collection<Writer>[][] matrix)	Creates a writing thread for a matrix of writers.
static Collection<Writer>	getAllWriters(Collection<Writer>[][] matrix)	Collects all writer instances from a matrix of writers.

Methods inherited from class java.lang.Object

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

Constructor Detail

TinylogLoggingConfiguration

public TinylogLoggingConfiguration()

Method Detail

createWriters

public Collection<Writer>[][] createWriters(List<String> tags,
                                            org.tinylog.Level minimumLevel,
                                            boolean writingThread)

Creates a two-dimensional matrix with all configured writers. The first dimension represents the tags. It starts with untagged writers, following with all tagged writers and ending with writers that accepts all kind of log entries. The total number of entries is the number of defined tags plus two. The second dimension represents the severity level. It starts with Level.TRACE and ends with Level.ERROR.

Parameters:

tags - Order of defined tags

minimumLevel - Minimum global severity level

writingThread - Defines whether WritingThread is enabled

Returns:

Matrix with all created writers

addWriter

protected void addWriter(Writer writer,
                         Collection<Writer>[][] matrix,
                         int tagIndex,
                         org.tinylog.Level level)

Adds a writer to a well-defined matrix. The given writer will be added only at the given tag index for severity levels equal or above the given severity level.

Parameters:

writer - Writer to add

matrix - Well-defined two-dimensional matrix

tagIndex - Represents the tag (first dimension of matrix)

level - Represents the severity level (second dimension of matrix)

calculateMinimumLevel

public org.tinylog.Level calculateMinimumLevel(org.tinylog.Level globalLevel,
                                               Map<String,org.tinylog.Level> customLevels)

Calculates the minimum severity level that can output any log entries.

Parameters:

globalLevel - Global severity level

customLevels - Custom severity levels for packages and classes

Returns:

Minimum severity level

calculateRequiredLogEntryValues

public Collection<LogEntryValue>[][] calculateRequiredLogEntryValues(Collection<Writer>[][] writers)

Creates a matrix with all required log entry values for each tag and severity level.

Parameters:

writers - Matrix with registered writers

Returns:

Matrix with all required log entry values

calculateFullStackTraceRequirements

public BitSet calculateFullStackTraceRequirements(Collection<LogEntryValue>[][] logEntryValues)

Calculates for which tag a full stack trace element with method name, file name and line number is required.

Parameters:

logEntryValues - Matrix with required log entry values

Returns:

Each set bit represents a tag that requires a full stack trace element

createWritingThread

public WritingThread createWritingThread(Collection<Writer>[][] matrix)

Creates a writing thread for a matrix of writers.

Parameters:

matrix - All writers

Returns:

Initialized and running writhing thread

getAllWriters

public static Collection<Writer> getAllWriters(Collection<Writer>[][] matrix)

Collects all writer instances from a matrix of writers.

Parameters:

matrix - All writers

Returns:

Collection that contains each writer only once

createLogEntry

public static LogEntry createLogEntry(StackTraceElement stackTraceElement,
                                      String tag,
                                      org.tinylog.Level level,
                                      Throwable exception,
                                      org.tinylog.format.MessageFormatter formatter,
                                      Object obj,
                                      Object[] arguments,
                                      Collection<LogEntryValue>[] requiredLogEntryValues,
                                      org.tinylog.provider.ContextProvider contextProvider)

Creates a new log entry.

Parameters:

stackTraceElement - Optional stack trace element of caller

tag - Tag name if issued from a tagged logger

level - Severity level

exception - Caught exception or throwable to log

formatter - Formatter for text message

obj - Message to log

arguments - Arguments for message

requiredLogEntryValues - The required log entry value array slice of the tag index of the used tag

contextProvider - The context provider

Returns:

Filled log entry