nutrient/com.pspdfkit.utils/PdfLog

PdfLog

Logger used for logging inside Nutrient.

This API allows injection of custom Logger implementations that can be used to achieve custom logging strategies for PSPDFKit framework logs.

Note: In a debuggable app the default Logger logs Log.DEBUG and above; in a release app it logs Log.INFO and above.

Types

Logger

fun interface Logger

Interface for custom loggers that can be registered in PdfLog to implement custom logging strategies.

LogPriority

annotation class LogPriority

Priority of log messages. Log priority defines verbosity of the message, from most verbose (Log.VERBOSE) to least (Log.ASSERT).

Functions

addLogger

@JvmStatic

fun addLogger(logger: PdfLog.Logger)

Adds a new logger that will be notified of all logs emitted by PdfLog.

@JvmStatic

fun d(tag: String, messageCallback: Callable<String>)

Logs a Log.DEBUG message. The messageCallback is invoked only when the log is accepted by a registered logger via Logger.isLogged.

@JvmStatic

fun d(tag: String, message: String?, vararg args: Any?)

Logs a Log.DEBUG message, with optional String.format for message.

@JvmStatic

fun d(tag: String, t: Throwable?, message: String?, vararg args: Any?)

Logs a Log.DEBUG message with an optional throwable t, and optional String.format.

@JvmStatic

fun e(tag: String, messageCallback: Callable<String>)

Logs an Log.ERROR message. The messageCallback is invoked only when the log is accepted by a registered logger via Logger.isLogged.

@JvmStatic

fun e(tag: String, message: String?, vararg args: Any?)

Logs an Log.ERROR message, with optional String.format for message.

@JvmStatic

fun e(tag: String, t: Throwable?, message: String?, vararg args: Any?)

Logs an Log.ERROR message with an optional throwable t, and optional String.format.

getLoggers

@JvmStatic

fun getLoggers(): List<PdfLog.Logger>

Returns an immutable snapshot of the currently registered loggers.

@JvmStatic

fun i(tag: String, messageCallback: Callable<String>)

Logs an Log.INFO message. The messageCallback is invoked only when the log is accepted by a registered logger via Logger.isLogged.

@JvmStatic

fun i(tag: String, message: String?, vararg args: Any?)

Logs an Log.INFO message, with optional String.format for message.

@JvmStatic

fun i(tag: String, t: Throwable?, message: String?, vararg args: Any?)

Logs an Log.INFO message with an optional throwable t, and optional String.format.

removeAllLoggers

@JvmStatic

fun removeAllLoggers()

Removes all registered loggers. Effectively disables logging.

removeLogger

@JvmStatic

fun removeLogger(logger: PdfLog.Logger)

Removes a previously registered logger.

setLoggers

@JvmStatic

fun setLoggers(loggers: Collection<PdfLog.Logger>)

@JvmStatic

fun setLoggers(vararg loggers: PdfLog.Logger)

Sets the loggers notified of all logs emitted by PdfLog, replacing all previously registered ones.

@JvmStatic

fun v(tag: String, messageCallback: Callable<String>)

Logs a Log.VERBOSE message. The messageCallback is invoked only when the log is accepted by a registered logger via Logger.isLogged.

@JvmStatic

fun v(tag: String, message: String?, vararg args: Any?)

Logs a Log.VERBOSE message, with optional String.format for message.

@JvmStatic

fun v(tag: String, t: Throwable?, message: String?, vararg args: Any?)

Logs a Log.VERBOSE message with an optional throwable t, and optional String.format.

@JvmStatic

fun w(tag: String, messageCallback: Callable<String>)

Logs a Log.WARN message. The messageCallback is invoked only when the log is accepted by a registered logger via Logger.isLogged.

@JvmStatic

fun w(tag: String, message: String?, vararg args: Any?)

Logs a Log.WARN message, with optional String.format for message.

@JvmStatic

fun w(tag: String, t: Throwable?, message: String?, vararg args: Any?)

Logs a Log.WARN message with an optional throwable t, and optional String.format.