CategoryLogger (Open Traffic Sim base classes 1.00.02 API)

java.lang.Object
- org.opentrafficsim.base.logger.CategoryLogger

```
public class CategoryLogger
extends Object
```
The CategoryLogger can log for specific Categories. The way to call the logger for messages that always need to be logged, such as an error with an exception is:
```
 CategoryLogger.always().error(exception, "Parameter {} did not initialize correctly", param1.toString());
 
```
It is also possible to indicate the category / categories for the message, which will only be logged if at least one of the indicated categories is turned on with addLogCategory() or setLogCategories(), or if one of the added or set LogCategories is LogCategory.ALL:
```
 CategoryLogger.filter(Cat.BASE).debug("Parameter {} initialized correctly", param1.toString());
 
```
Copyright (c) 2003-2018 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl. The source code and binary code of this software is proprietary information of Delft University of Technology.
Author:

Alexander Verbraeck

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CategoryLogger.DelegateLogger
DelegateLogger class that takes care of actually logging the message and/or exception.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CategoryLogger.DelegateLogger` DelegateLogger class that takes care of actually logging the message and/or exception.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Set<LogCategory>`	`categories` The categories to log.
`static String`	`DEFAULT_MESSAGE_FORMAT` The default message format.
`protected static CategoryLogger.DelegateLogger`	`delegateLogger` The delegate logger instance that does the actual logging work, after a positive filter outcome.
`protected static CategoryLogger.DelegateLogger`	`noLogger` The delegate logger that returns immediately after a negative filter outcome.

Constructor Summary

Constructors
Modifier Constructor and Description

protected CategoryLogger()

Constructors
Modifier	Constructor and Description
`protected`	`CategoryLogger()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addLogCategory(LogCategory logCategory)` Add a category to be logged to the Writers.
`static CategoryLogger.DelegateLogger`	`always()` The "pass" filter that will result in always trying to log.
`protected static void`	`create()` Create a new logger for the system console.
`static CategoryLogger.DelegateLogger`	`filter(LogCategory... logCategories)` Check whether the provided categories contain one or more categories that need to be logged.
`static CategoryLogger.DelegateLogger`	`filter(LogCategory logCategory)` Check whether the provided category needs to be logged.
`static CategoryLogger.DelegateLogger`	`filter(Set<LogCategory> logCategories)` Check whether the provided categories contain one or more categories that need to be logged.
`static void`	`removeLogCategory(LogCategory logCategory)` Remove a category to be logged to the Writers.
`static void`	`setAllLogLevel(org.pmw.tinylog.Level newLevel)` Set a new logging level for all registered writers.
`static void`	`setAllLogMessageFormat(String newMessageFormat)` Set a new logging format for the message lines of all writers.
`static void`	`setLogCategories(LogCategory... newLogCategories)` Set the categories to be logged to the Writers.
`static void`	`setLogLevel(org.pmw.tinylog.writers.Writer writer, org.pmw.tinylog.Level newLevel)` Set a new logging level for one of the registered writers.
`static void`	`setLogMessageFormat(org.pmw.tinylog.writers.Writer writer, String newMessageFormat)` Set a new logging format for the message lines of a writer.

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

- Field Detail
  - DEFAULT_MESSAGE_FORMAT
```
public static final String DEFAULT_MESSAGE_FORMAT
```
    The default message format.
    
    See Also:
    
    Constant Field Values
  - categories
```
protected static Set<LogCategory> categories
```
    The categories to log.
  - delegateLogger
```
protected static CategoryLogger.DelegateLogger delegateLogger
```
    The delegate logger instance that does the actual logging work, after a positive filter outcome.
  - noLogger
```
protected static CategoryLogger.DelegateLogger noLogger
```
    The delegate logger that returns immediately after a negative filter outcome.
- Constructor Detail
  - CategoryLogger
```
protected CategoryLogger()
```
- Method Detail
  - create
```
protected static void create()
```
    Create a new logger for the system console. Note that this REPLACES current writers. Note that the initial LogCategory is LogCategory.ALL, so all categories will be logged. This category has to be explicitly removed (or new categories have to be set) to log a limited set of categories.
  - setAllLogMessageFormat
```
public static void setAllLogMessageFormat(String newMessageFormat)
```
    Set a new logging format for the message lines of all writers. The default message format is:
    {class_name}.{method}:{line} {message|indent=4}
    
    A few popular placeholders that can be used:
    - {class} Fully-qualified class name where the logging request is issued
    - {class_name} Class name (without package) where the logging request is issued
    - {date} Date and time of the logging request, e.g. {date:yyyy-MM-dd HH:mm:ss} [SimpleDateFormat]
    - {level} Logging level of the created log entry
    - {line} Line number from where the logging request is issued
    - {message} Associated message of the created log entry
    - {method} Method name from where the logging request is issued
    - {package} Package where the logging request is issued
    
    Parameters:
    
    newMessageFormat - the new formatting pattern to use for all registered writers
    
    See Also:
    
    https://tinylog.org/configuration
  - setAllLogLevel
```
public static void setAllLogLevel(org.pmw.tinylog.Level newLevel)
```
    Set a new logging level for all registered writers.
    
    Parameters:
    
    newLevel - the new log level for all registered writers
  - setLogMessageFormat
```
public static void setLogMessageFormat(org.pmw.tinylog.writers.Writer writer,
                                       String newMessageFormat)
```
    Set a new logging format for the message lines of a writer. The default message format is:
    {class_name}.{method}:{line} {message|indent=4}
    
    A few popular placeholders that can be used:
    - {class} Fully-qualified class name where the logging request is issued
    - {class_name} Class name (without package) where the logging request is issued
    - {date} Date and time of the logging request, e.g. {date:yyyy-MM-dd HH:mm:ss} [SimpleDateFormat]
    - {level} Logging level of the created log entry
    - {line} Line number from where the logging request is issued
    - {message} Associated message of the created log entry
    - {method} Method name from where the logging request is issued
    - {package} Package where the logging request is issued
    
    Parameters:
    
    writer - the writer to change the message format for
    
    newMessageFormat - the new formatting pattern to use for all registered writers
    
    See Also:
    
    https://tinylog.org/configuration
  - setLogLevel
```
public static void setLogLevel(org.pmw.tinylog.writers.Writer writer,
                               org.pmw.tinylog.Level newLevel)
```
    Set a new logging level for one of the registered writers.
    
    Parameters:
    
    writer - the writer to change the log level for
    
    newLevel - the new log level for the writer
  - addLogCategory
```
public static void addLogCategory(LogCategory logCategory)
```
    Add a category to be logged to the Writers.
    
    Parameters:
    
    logCategory - the LogCategory to add
  - removeLogCategory
```
public static void removeLogCategory(LogCategory logCategory)
```
    Remove a category to be logged to the Writers.
    
    Parameters:
    
    logCategory - the LogCategory to remove
  - setLogCategories
```
public static void setLogCategories(LogCategory... newLogCategories)
```
    Set the categories to be logged to the Writers.
    
    Parameters:
    
    newLogCategories - the LogCategories to set, replacing the previous ones
  - always
```
public static CategoryLogger.DelegateLogger always()
```
    The "pass" filter that will result in always trying to log.
    
    Returns:
    
    the logger that tries to execute logging (delegateLogger)
  - filter
```
public static CategoryLogger.DelegateLogger filter(LogCategory logCategory)
```
    Check whether the provided category needs to be logged. Note that when LogCategory.ALL is contained in the categories, filter will return true.
    
    Parameters:
    
    logCategory - the category to check for.
    
    Returns:
    
    the logger that either tries to log (delegateLogger), or returns without logging (noLogger)
  - filter
```
public static CategoryLogger.DelegateLogger filter(LogCategory... logCategories)
```
    Check whether the provided categories contain one or more categories that need to be logged. Note that when LogCategory.ALL is contained in the categories, filter will return true.
    
    Parameters:
    
    logCategories - LogCategory...; elements or array with the categories to check for
    
    Returns:
    
    the logger that either tries to log (delegateLogger), or returns without logging (noLogger)
  - filter
```
public static CategoryLogger.DelegateLogger filter(Set<LogCategory> logCategories)
```
    Check whether the provided categories contain one or more categories that need to be logged. Note that when LogCategory.ALL is contained in the categories, filter will return true.
    
    Parameters:
    
    logCategories - Set<LogCategory>; the categories to check for
    
    Returns:
    
    the logger that either tries to log (delegateLogger), or returns without logging (noLogger)

Class CategoryLogger

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MESSAGE_FORMAT

categories

delegateLogger

noLogger

Constructor Detail

CategoryLogger

Method Detail

create

setAllLogMessageFormat

setAllLogLevel

setLogMessageFormat

setLogLevel

addLogCategory

removeLogCategory

setLogCategories

always

filter

filter

filter