Configurator (tinylog 1.3.6 API)

java.lang.Object
- org.pmw.tinylog.Configurator

public final class Configurator
extends Object

Configurator to configure Logger.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`activate()`	Activate the configuration.
`Configurator`	`addWriter(Writer writer)`	Add an additional writer for outputting the created log entries.
`Configurator`	`addWriter(Writer writer, String formatPattern)`	Add an additional writer for outputting the created log entries.
`Configurator`	`addWriter(Writer writer, Level level)`	Add an additional writer for outputting the created log entries.
`Configurator`	`addWriter(Writer writer, Level level, String formatPattern)`	Add an additional writer for outputting the created log entries.
`static Configurator`	`currentConfig()`	Create a new configurator, based on the current configuration.
`static Configurator`	`defaultConfig()`	Create a new configurator, based on the default configuration.
`Configurator`	`formatPattern(String formatPattern)`	Set the format pattern for log entries.
`static Configurator`	`fromFile(File file)`	Load a properties file from file system.
`static Configurator`	`fromMap(Map<String,?> map)`	Load properties from a `Map`.
`static Configurator`	`fromResource(String file)`	Load a properties file from classpath.
`static Configurator`	`fromStream(InputStream stream)`	Load a properties file from an input stream.
`static Configurator`	`fromURL(URL url)`	Load a properties file from a URL.
`Configurator`	`level(Class<?> classObject, Level level)`	Set a custom severity level for a class.
`Configurator`	`level(Package packageObject, Level level)`	Set a custom severity level for a package.
`Configurator`	`level(String packageOrClass, Level level)`	Set a custom severity level for a package or class.
`Configurator`	`level(Level level)`	Change the severity level.
`Configurator`	`locale(Locale locale)`	Set the locale that is used to render format patterns for log entries.
`Configurator`	`maxStackTraceElements(int maxStackTraceElements)`	Set the limit of stack traces for exceptions (default is 40).
`Configurator`	`removeAllWriters()`	Remove all writers.
`Configurator`	`removeWriter(Writer writer)`	Remove a writer.
`Configurator`	`resetCustomLevels()`	Reset all custom severity levels (to use the default severity level again).
`static void`	`shutdownConfigurationObserver(boolean wait)`	Manually shutdown of configuration observer.
`static void`	`shutdownWritingThread(boolean wait)`	Manually shutdown of writing thread.
`Configurator`	`writer(Writer writer)`	Set a writer to output created log entries.
`Configurator`	`writer(Writer writer, String formatPattern)`	Set a writer to output created log entries.
`Configurator`	`writer(Writer writer, Level level)`	Set a writer to output created log entries.
`Configurator`	`writer(Writer writer, Level level, String formatPattern)`	Set a writer to output created log entries.
`Configurator`	`writingThread(boolean enable)`	The writing thread can writes log entries asynchronously.
`Configurator`	`writingThread(int priority)`	The writing thread can writes log entries asynchronously.
`Configurator`	`writingThread(String threadToObserve)`	The writing thread can writes log entries asynchronously.
`Configurator`	`writingThread(String threadToObserve, int priority)`	The writing thread can writes log entries asynchronously.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - defaultConfig
```
public static Configurator defaultConfig()
```
    Create a new configurator, based on the default configuration.
    
    Returns:
    
    A new configurator
  - currentConfig
```
public static Configurator currentConfig()
```
    Create a new configurator, based on the current configuration.
    
    Returns:
    
    A new configurator
  - fromResource
```
public static Configurator fromResource(String file)
                                 throws IOException
```
    Load a properties file from classpath.
    
    Parameters:
    
    file - Path to file to load
    
    Returns:
    
    A new configurator
    
    Throws:
    
    IOException - Failed to load and read file
  - fromFile
```
public static Configurator fromFile(File file)
                             throws IOException
```
    Load a properties file from file system.
    
    Parameters:
    
    file - File to load
    
    Returns:
    
    A new configurator
    
    Throws:
    
    IOException - Failed to load and read file
  - fromStream
```
public static Configurator fromStream(InputStream stream)
                               throws IOException
```
    Load a properties file from an input stream.
    
    Parameters:
    
    stream - Properties file
    
    Returns:
    
    A new configurator
    
    Throws:
    
    IOException - Failed to read from stream
  - fromURL
```
public static Configurator fromURL(URL url)
                            throws IOException
```
    Load a properties file from a URL.
    
    Parameters:
    
    url - Properties file
    
    Returns:
    
    A new configurator
    
    Throws:
    
    IOException - Failed to read from URL
  - fromMap
```
public static Configurator fromMap(Map<String,?> map)
```
    Load properties from a Map.
    
    Parameters:
    
    map - Map with configuration
    
    Returns:
    
    A new configurator
  - level
```
public Configurator level(Level level)
```
    Change the severity level. The logger creates and outputs only log entries for the current severity level and higher.
    
    Parameters:
    
    level - New severity level
    
    Returns:
    
    The current configurator
  - level
```
public Configurator level(Package packageObject,
                          Level level)
```
    Set a custom severity level for a package. This will override the default severity level for this package.
    
    Parameters:
    
    packageObject - Package
    
    level - The severity level (or null to reset it to the default severity level)
    
    Returns:
    
    The current configurator
  - level
```
public Configurator level(Class<?> classObject,
                          Level level)
```
    Set a custom severity level for a class. This will override the default severity level for this class.
    
    Parameters:
    
    classObject - Class
    
    level - The severity level (or null to reset it to the default severity level)
    
    Returns:
    
    The current configurator
  - level
```
public Configurator level(String packageOrClass,
                          Level level)
```
    Set a custom severity level for a package or class. This will override the default severity level for this package respectively class.
    
    Parameters:
    
    packageOrClass - Name of a package or class
    
    level - The severity level (or null to reset it to the default severity level)
    
    Returns:
    
    The current configurator
  - resetCustomLevels
```
public Configurator resetCustomLevels()
```
    Reset all custom severity levels (to use the default severity level again).
    
    Returns:
    
    The current configurator
  - formatPattern
```
public Configurator formatPattern(String formatPattern)
```
    Set the format pattern for log entries. "{date:yyyy-MM-dd HH:mm:ss} [{thread}] {class}.{method}()\n{level}: {message}" is the default format pattern. The date format pattern is compatible with SimpleDateFormat.
    
    Parameters:
    
    formatPattern - Format pattern for log entries (or null to reset to default)
    
    Returns:
    
    The current configurator
    
    See Also:
    
    SimpleDateFormat
  - locale
```
public Configurator locale(Locale locale)
```
    Set the locale that is used to render format patterns for log entries. It will be used e. g. to format numbers and dates.
    
    Parameters:
    
    locale - Locale for format patterns
    
    Returns:
    
    The current configurator
  - writer
```
public Configurator writer(Writer writer)
```
    Set a writer to output created log entries. All existing writers will be replaced.
    
    Parameters:
    
    writer - Writer to set (can be null to disable any output)
    
    Returns:
    
    The current configurator
  - writer
```
public Configurator writer(Writer writer,
                           Level level)
```
    Set a writer to output created log entries. All existing writers will be replaced.
    
    Parameters:
    
    writer - Writer to set (can be null to disable any output)
    
    level - Writer will output entries with the same or higher severity level
    
    Returns:
    
    The current configurator
  - writer
```
public Configurator writer(Writer writer,
                           String formatPattern)
```
    Set a writer to output created log entries. All existing writers will be replaced.
    
    Parameters:
    
    writer - Writer to set (can be null to disable any output)
    
    formatPattern - Format pattern to use instead of the global format pattern to render log entries
    
    Returns:
    
    The current configurator
  - writer
```
public Configurator writer(Writer writer,
                           Level level,
                           String formatPattern)
```
    Set a writer to output created log entries. All existing writers will be replaced.
    
    Parameters:
    
    writer - Writer to set (can be null to disable any output)
    
    level - Writer will output entries with the same or higher severity level
    
    formatPattern - Format pattern to use instead of the global format pattern to render log entries
    
    Returns:
    
    The current configurator
  - addWriter
```
public Configurator addWriter(Writer writer)
```
    Add an additional writer for outputting the created log entries.
    
    Parameters:
    
    writer - Writer to add
    
    Returns:
    
    The current configurator
  - addWriter
```
public Configurator addWriter(Writer writer,
                              Level level)
```
    Add an additional writer for outputting the created log entries.
    
    Parameters:
    
    writer - Writer to add
    
    level - Writer will output entries with the same or higher severity level
    
    Returns:
    
    The current configurator
  - addWriter
```
public Configurator addWriter(Writer writer,
                              String formatPattern)
```
    Add an additional writer for outputting the created log entries.
    
    Parameters:
    
    writer - Writer to add
    
    formatPattern - Format pattern to use instead of the global format pattern to render log entries
    
    Returns:
    
    The current configurator
  - addWriter
```
public Configurator addWriter(Writer writer,
                              Level level,
                              String formatPattern)
```
    Add an additional writer for outputting the created log entries.
    
    Parameters:
    
    writer - Writer to set (can be null to disable any output)
    
    level - Writer will output entries with the same or higher severity level
    
    formatPattern - Format pattern to use instead of the global format pattern to render log entries
    
    Returns:
    
    The current configurator
  - removeWriter
```
public Configurator removeWriter(Writer writer)
```
    Remove a writer.
    
    Parameters:
    
    writer - Writer to remove
    
    Returns:
    
    The current configurator
  - removeAllWriters
```
public Configurator removeAllWriters()
```
    Remove all writers.
    
    Returns:
    
    The current configurator
  - writingThread
```
public Configurator writingThread(boolean enable)
```
    The writing thread can writes log entries asynchronously. This thread will automatically shutdown, if the main thread is dead.
    
    Parameters:
    
    enable - true to enable the writing thread, false to disable it
    
    Returns:
    
    The current configurator
  - writingThread
```
public Configurator writingThread(int priority)
```
    The writing thread can writes log entries asynchronously. This thread will automatically shutdown, if the main thread is dead.
    
    Parameters:
    
    priority - Priority of the writing thread (must be between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY)
    
    Returns:
    
    The current configurator
  - writingThread
```
public Configurator writingThread(String threadToObserve)
```
    The writing thread can writes log entries asynchronously. This thread will automatically shutdown, if the observed thread is dead.
    
    Parameters:
    
    threadToObserve - Name of the tread to observe (e.g. "main" for the main thread) or null to disable automatic shutdown
    
    Returns:
    
    The current configurator
  - writingThread
```
public Configurator writingThread(String threadToObserve,
                                  int priority)
```
    The writing thread can writes log entries asynchronously. This thread will automatically shutdown, if the observed thread is dead.
    
    Parameters:
    
    threadToObserve - Name of the tread to observe (e.g. "main" for the main thread) or null to disable automatic shutdown
    
    priority - Priority of the writing thread (must be between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY)
    
    Returns:
    
    The current configurator
  - maxStackTraceElements
```
public Configurator maxStackTraceElements(int maxStackTraceElements)
```
    Set the limit of stack traces for exceptions (default is 40). Can be set to "-1" for no limitation and to "0" to disable any stack traces.
    
    Parameters:
    
    maxStackTraceElements - Limit of stack traces
    
    Returns:
    
    The current configurator
  - activate
```
public boolean activate()
```
    Activate the configuration.
    
    Returns:
    
    true if the configuration has been successfully activated, false if the activation failed
  - shutdownWritingThread
```
public static void shutdownWritingThread(boolean wait)
```
    Manually shutdown of writing thread.
    
    Parameters:
    
    wait - true to wait for the successful shutdown, false for an asynchronous shutdown
  - shutdownConfigurationObserver
```
public static void shutdownConfigurationObserver(boolean wait)
```
    Manually shutdown of configuration observer.
    
    Parameters:
    
    wait - true to wait for the successful shutdown, false for an asynchronous shutdown

Class Configurator

Method Summary

Methods inherited from class java.lang.Object

Method Detail

defaultConfig

currentConfig

fromResource

fromFile

fromStream

fromURL

fromMap

level

level

level

level

resetCustomLevels

formatPattern

locale

writer

writer

writer

writer

addWriter

addWriter

addWriter

addWriter

removeWriter

removeAllWriters

writingThread

writingThread

writingThread

writingThread

maxStackTraceElements

activate

shutdownWritingThread

shutdownConfigurationObserver