Added in API level 1
Deprecated in API level 30

TimingLogger


open class TimingLogger
kotlin.Any
   ↳ android.util.TimingLogger

A utility class to help log timings splits throughout a method call. Typical usage is:

TimingLogger timings = new TimingLogger(TAG, "methodA");
      // ... do some work A ...
      timings.addSplit("work A");
      // ... do some work B ...
      timings.addSplit("work B");
      // ... do some work C ...
      timings.addSplit("work C");
      timings.dumpToLog();
  

The dumpToLog call would add the following to the log:

D/TAG     ( 3459): methodA: begin
      D/TAG     ( 3459): methodA:      9 ms, work A
      D/TAG     ( 3459): methodA:      1 ms, work B
      D/TAG     ( 3459): methodA:      6 ms, work C
      D/TAG     ( 3459): methodA: end, 16 ms
  

Summary

Public constructors
TimingLogger(tag: String!, label: String!)

Create and initialize a TimingLogger object that will log using the specific tag.

Public methods
open Unit
addSplit(splitLabel: String!)

Add a split for the current time, labeled with splitLabel.

open Unit

Dumps the timings to the log using Log.

open Unit
reset(tag: String!, label: String!)

Clear and initialize a TimingLogger object that will log using the specific tag.

open Unit

Clear and initialize a TimingLogger object that will log using the tag and label that was specified previously, either via the constructor or a call to reset(tag, label).

Public constructors

TimingLogger

Added in API level 1
TimingLogger(
    tag: String!,
    label: String!)

Create and initialize a TimingLogger object that will log using the specific tag. If the Log.isLoggable is not enabled to at least the Log.VERBOSE level for that tag at creation time then the addSplit and dumpToLog call will do nothing.

Parameters
tag String!: the log tag to use while logging the timings
label String!: a string to be displayed with each log

Public methods

addSplit

Added in API level 1
open fun addSplit(splitLabel: String!): Unit

Deprecated: Deprecated in Java.

Add a split for the current time, labeled with splitLabel. If Log.isLoggable was not enabled to at least the Log.VERBOSE for the specified tag at construction or reset() time then this call does nothing.

Parameters
splitLabel String!: a label to associate with this split.

dumpToLog

Added in API level 1
open fun dumpToLog(): Unit

Deprecated: Deprecated in Java.

Dumps the timings to the log using Log.d(). If Log.isLoggable was not enabled to at least the Log.VERBOSE for the specified tag at construction or reset() time then this call does nothing.

reset

Added in API level 1
open fun reset(
    tag: String!,
    label: String!
): Unit

Deprecated: Deprecated in Java.

Clear and initialize a TimingLogger object that will log using the specific tag. If the Log.isLoggable is not enabled to at least the Log.VERBOSE level for that tag at creation time then the addSplit and dumpToLog call will do nothing.

Parameters
tag String!: the log tag to use while logging the timings
label String!: a string to be displayed with each log

reset

Added in API level 1
open fun reset(): Unit

Deprecated: Deprecated in Java.

Clear and initialize a TimingLogger object that will log using the tag and label that was specified previously, either via the constructor or a call to reset(tag, label). If the Log.isLoggable is not enabled to at least the Log.VERBOSE level for that tag at creation time then the addSplit and dumpToLog call will do nothing.