logging/com.diamondedge.logging

Package-level declarations

Types

FixedLogLevel

class FixedLogLevel(isLogging: Boolean) : LogLevelController

All logging levels are either enabled or disabled.

KmLog

open class KmLog(tag: String)

KmLogging

object KmLogging

KmModuleLog

class KmModuleLog(val log: KmLog, val isModuleLogging: () -> Boolean)

Wrapper for KmLog that allows library modules to also use KmLogging and be able to enable or disable its logging independently of the application that is also using KmLogging.

Log

class Log

LogFactory

interface LogFactory

Logger

interface Logger : LoggerApi, LogLevelController

LoggerApi

interface LoggerApi

LogLevel

enum LogLevel : Enum<LogLevel>

Enum representing a log level where that level and all succeeding less granular levels are enabled. Verbose is the lowest level means all levels are enabled and Error means only Error

LogLevelController

interface LogLevelController

Platform

object Platform

PlatformLogger

class PlatformLogger(logLevel: LogLevelController) : Logger, TagProvider, LogLevelController

PrintLogger

class PrintLogger(logLevel: LogLevelController) : Logger, LogLevelController

Slf4jLog

class Slf4jLog(tag: String, className: String) : KmLog

Slf4jLogFactory

class Slf4jLogFactory : LogFactory

TagProvider

interface TagProvider

TimingLog

class TimingLog(label: String, tag: String? = null)

Add logs containing how long it took to do each section. The logs will be added at the debug log level so the debug log level must be enabled. Verbose level logging creates a new section which is also totaled by the next debug level logs. If only logging debug level then the verbose level logs are not sent to the logs. Usage: val log = TimingLog("work") ... do work A (taking 5 ms) log.debug { "A" } ... do work B 1 (taking 1 ms) log.verbose { "B 1" } ... do work B 2 (taking 3 ms) log.verbose { "B 2" } log.debug { "B" } log.finish()

VariableLogLevel

class VariableLogLevel(level: Int) : LogLevelController

Each logging level is controlled by the bit mask of the given log level.

Properties

DEBUG_MASK

const val DEBUG_MASK: Int = 8

ERROR_MASK

const val ERROR_MASK: Int = 1

INFO_MASK

const val INFO_MASK: Int = 4

VERBOSE_MASK

const val VERBOSE_MASK: Int = 16

WARN_MASK

const val WARN_MASK: Int = 2

Functions

logging

fun logging(tag: String? = null): KmLog

Create a logging object. This is the primary entry point for logging and should be called once for each file, class or object. For classes a val can be created either as a private member of the class or as a member of the companion object.