com.ybo.trackingplugin.tracerlib.Tracer.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of traceplugin Show documentation

gradle plugin allowing to add automatic logs (or other process) at the start of each traced method

There is a newer version: 0.6.2

package com.ybo.trackingplugin.tracerlib

/** object whose [Tracer.trace] method is called at each call of the methods annotated with the trace annotation*/
interface Tracer {

    /** called on the call of traced method. To be overriden by user of the plugin.
     * Note that history is maxed at 100. After that the oldest item is discarded.
     *
     * returns true if we want to empty the history after tracing the current method
     * */
    fun trace(
        defaultMessage: String,
        java: Boolean,
        method: Method,
        history: List,
        parameterValues: Array,
    ): Boolean

    data class Method(
        val originalName: String,
        val possiblyObfuscatedMethod: String,
        val link: String = "",
    )

    /** factory for Tracers. */
    interface Factory {
        /** instantiates a Tracer. */
        fun create(): Tracer
    }
}