Module org.tinylog.api

Package org.tinylog.configuration

Class Configuration

java.lang.Object

org.tinylog.configuration.Configuration

public final class Configuration
extends java.lang.Object

Global configuration for tinylog.

By default, the configuration will be loaded from tinylog.properties in the default package. Another configuration file can be loaded by setting the system property tinylog.configuration. The configuration file can be a resource in the classpath, a file from file system or an URL

Alternately configuration properties can be set via system properties. These properties must be prefixed by "tinylog.". For example: "level = debug" becomes "tinylog.level=debug". If a configuration property exists as system property and in configuration file, the system property will win.

Method Summary

Modifier and Type	Method	Description
static java.lang.String	get(java.lang.String key)	Gets a configuration property.
static java.util.Map<java.lang.String,java.lang.String>	getChildren(java.lang.String key)	Gets all child properties for a parent property.
static java.util.Map<java.lang.String,java.lang.String>	getSiblings(java.lang.String prefix)	Gets all siblings with a defined prefix.
static void	replace(java.util.Map<java.lang.String,java.lang.String> configuration)	Replaces the current configuration by a new one.
static void	set(java.lang.String key, java.lang.String value)	Sets a property.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static java.lang.String get(java.lang.String key)

Gets a configuration property. Keys a case-sensitive.

Parameters:

key - Case-sensitive key of property

Returns:

Found value or null

getSiblings

public static java.util.Map<java.lang.String,java.lang.String> getSiblings(java.lang.String prefix)

Gets all siblings with a defined prefix. Child properties will be not returned.

Example:

getSiblings("writer") will return properties with the keys writer as well as writerTest but not with the key writer.test. Dots after a prefix ending with an at sign will be not handled as children. Therefore, getSiblings("level@") will return a property with the key [email protected].

Parameters:

prefix - Case-sensitive prefix for keys

Returns:

All found properties (map will be empty if there are no matching properties)

getChildren

public static java.util.Map<java.lang.String,java.lang.String> getChildren(java.lang.String key)

Gets all child properties for a parent property. The parent property itself will be not returned. Children keys will be returned without parent key prefix.

For example: getChildren("writer") will return the property writer.level as level.

Parameters:

key - Case-sensitive key of parent property

Returns:

All found children properties (map will be empty if there are no children properties)

set

public static void set(java.lang.String key,
                       java.lang.String value)

Sets a property. If there is already a value for the given key, it will be overridden by the new value.

Configuration properties must be set before calling any logging methods. If the framework has been initialized once, the configuration is immutable and further configuration changes will be just ignored.

Parameters:

key - Name of the property

value - Value of the property

replace

public static void replace(java.util.Map<java.lang.String,java.lang.String> configuration)

Replaces the current configuration by a new one. Already existing properties will be dropped.

Configuration properties must be set before calling any logging methods. If the framework has been initialized once, the configuration is immutable and further configuration changes will be just ignored.

Parameters:

configuration - New configuration