org.tinylog.configuration

Class Configuration

java.lang.Object

org.tinylog.configuration.Configuration

public final class Configuration
extends 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.

The default property loading behavior can be changed by supplying a property service loader which reads the properties in any other way. The properties can have a priority. The service loader which loads the properties with the highest priority is chosen. Alternatively, the loader can be directly chosen by setting a system property "tinylog.configurationloader" to the simple class name of the desired loader.

Method Summary

Modifier and Type	Method and Description
static String	get(String key) Gets a configuration property.
static Map<String,String>	getChildren(String key) Gets all child properties for a parent property.
static Locale	getLocale() Gets the global locale.
static Map<String,String>	getSiblings(String prefix) Gets all siblings with a defined prefix.
static boolean	isEscapingEnabled() Checks whether escaping is enabled or disabled.
static boolean	isFrozen() Checks whether the configuration is already frozen.
static void	mergeSystemProperties(Properties properties) Merges system properties starting with the Tinylog property prefix into the given properties.
static void	replace(Map<String,String> configuration) Replaces the current configuration by a new one.
static String	resolve(String value, org.tinylog.configuration.Resolver resolver) Resolves placeholders with passed resolver.
static void	resolveProperties(Properties properties, org.tinylog.configuration.Resolver... resolvers) Resolves the given property entries with the provided resolvers.
static void	set(String key, 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

getLocale

public static Locale getLocale()

Gets the global locale.

Returns:

Locale from property locale or Locale.ROOT if no locale is configured

isEscapingEnabled

public static boolean isEscapingEnabled()

Checks whether escaping is enabled or disabled.

Returns:

true if escaping is enabled, otherwise false

get

public static String get(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 Map<String,String> getSiblings(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 level@com.test.

Parameters:

prefix - Case-sensitive prefix for keys

Returns:

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

getChildren

public static Map<String,String> getChildren(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(String key,
                       String value)
                throws UnsupportedOperationException

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 throw an UnsupportedOperationException.

Parameters:

key - Name of the property

value - Value of the property

Throws:

UnsupportedOperationException - Configuration has already been applied and is frozen

replace

public static void replace(Map<String,String> configuration)
                    throws UnsupportedOperationException

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 throw an UnsupportedOperationException.

Parameters:

configuration - New configuration

Throws:

UnsupportedOperationException - Configuration has already been applied and is frozen

resolve

public static String resolve(String value,
                             org.tinylog.configuration.Resolver resolver)

Resolves placeholders with passed resolver.

Parameters:

value - String with placeholders

resolver - Resolver for replacing placeholders

Returns:

Input value with resolved placeholders

mergeSystemProperties

public static void mergeSystemProperties(Properties properties)

Merges system properties starting with the Tinylog property prefix into the given properties.

Parameters:

properties - The properties which the system values shall be merged into

resolveProperties

public static void resolveProperties(Properties properties,
                                     org.tinylog.configuration.Resolver... resolvers)

Resolves the given property entries with the provided resolvers.

Parameters:

properties - The properties which shall be resolved

resolvers - One or more resolvers to apply to each property entry

isFrozen

public static boolean isFrozen()

Checks whether the configuration is already frozen.

Returns:

true if the configuration is frozen, otherwise false