commonMain.com.harmony.kotlin.common.logger.Logger.kt Maven / Gradle / Ivy

Go to download
package com.harmony.kotlin.common.logger

/** Logging interface.  */
@Suppress("TooManyFunctions")
interface Logger {

  enum class Level(val representation: String) {
    VERBOSE("VERBOSE"),
    DEBUG("DEBUG"),
    INFO("INFO"),
    WARNING("WARNING"),
    ERROR("ERROR")
  }

  /** Logs a String object using a given level.  */
  fun log(level: Level, tag: String? = null, message: String)

  /** Logs a String and Throwable object using a given level.  */
  fun log(level: Level, throwable: Throwable, tag: String? = null, message: String)

  /** Logs a key-value pair.  */
  fun log(key: String, value: Any?)

  /** DEFAULT IMPLEMENTATIONS  */

  /** Log a verbose message.  */
  fun v(tag: String, message: String) {
    this.log(Level.VERBOSE, tag, message)
  }

  /** Log a verbose exception and a message.  */
  fun v(tag: String, t: Throwable, message: String) {
    this.log(Level.VERBOSE, t, tag, message)
  }

  /** Log a verbose message without tag.  */
  fun v(message: String) {
    this.log(Level.VERBOSE, null, message)
  }

  /** Log a debug message.  */
  fun d(tag: String, message: String) {
    this.log(Level.DEBUG, tag, message)
  }

  /** Log a debug exception and a message.  */
  fun d(tag: String, t: Throwable, message: String) {
    this.log(Level.DEBUG, t, tag, message)
  }

  /** Log a debug message.  */
  fun d(message: String) {
    this.log(Level.DEBUG, null, message)
  }

  /** Log an info message.  */
  fun i(tag: String, message: String) {
    this.log(Level.INFO, tag, message)
  }

  /** Log an info exception and a message.  */
  fun i(tag: String, t: Throwable, message: String) {
    this.log(Level.INFO, t, tag, message)
  }

  /** Log an info message.  */
  fun i(message: String) {
    this.log(Level.INFO, null, message)
  }

  /** Log a warning message.  */
  fun w(tag: String, message: String) {
    this.log(Level.WARNING, tag, message)
  }

  /** Log a warning exception and a message.  */
  fun w(tag: String, t: Throwable, message: String) {
    this.log(Level.WARNING, t, tag, message)
  }

  /** Log a warning message.  */
  fun w(message: String) {
    this.log(Level.WARNING, null, message)
  }

  /** Log an error message.  */
  fun e(tag: String, message: String) {
    this.log(Level.ERROR, tag, message)
  }

  /** Log an error exception and a message.  */
  fun e(tag: String, t: Throwable, message: String) {
    this.log(Level.ERROR, t, tag, message)
  }

  /** Log an error message.  */
  fun e(message: String) {
    this.log(Level.ERROR, null, message)
  }

  /** Method to send issue to external servers or local files.  */
  fun sendIssue(tag: String, message: String)

  /** Sets a device detail with boolean type.  */
  fun setDeviceBoolean(key: String, value: Boolean)

  /** Sets a device detail with string type.  */
  fun setDeviceString(key: String, value: String)

  /** Sets a device detail with integer type.  */
  fun setDeviceInteger(key: String, value: Int)

  /** Sets a device detail with double type.  */

  fun setDeviceFloat(key: String, value: Float)

  /** Remove a device detail.  */
  fun removeDeviceKey(key: String)

  /** Get the device identifier generated.  */
  val deviceIdentifier: String
}