summaryrefslogtreecommitdiff
path: root/main/java/com/google/android/setupcompat/logging/Timer.java
blob: 7d2a2c9b164d2b18af0ade74a41064900096ebff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.android.setupcompat.logging;

import android.util.Log;
import com.google.android.setupcompat.internal.ClockProvider;
import com.google.common.base.Preconditions;

/** Convenience utility to log duration events. Please note that this class is not thread-safe. */
public final class Timer {
  /** Creates a new instance of timer for the given {@code metricKey}. */
  public Timer(MetricKey metricKey) {
    this.metricKey = metricKey;
  }

  /**
   * Starts the timer and notes the current clock time.
   *
   * @throws IllegalStateException if the timer was stopped.
   */
  public void start() {
    Preconditions.checkState(!isStopped(), "Timer cannot be started once stopped.");
    if (isStarted()) {
      Log.wtf(
          TAG,
          String.format(
              "Timer instance was already started for: %s at [%s].", metricKey, startInNanos));
      return;
    }
    startInNanos = ClockProvider.timeInNanos();
  }

  /**
   * Stops the watch and the current clock time is noted.
   *
   * @throws IllegalStateException if the watch was not started.
   */
  public void stop() {
    Preconditions.checkState(isStarted(), "Timer must be started before it can be stopped.");
    if (isStopped()) {
      Log.wtf(
          TAG,
          String.format(
              "Timer instance was already stopped for: %s at [%s]", metricKey, stopInNanos));
      return;
    }
    stopInNanos = ClockProvider.timeInNanos();
  }

  boolean isStopped() {
    return stopInNanos != 0;
  }

  private boolean isStarted() {
    return startInNanos != 0;
  }

  long getDurationInNanos() {
    return stopInNanos - startInNanos;
  }

  MetricKey getMetricKey() {
    return metricKey;
  }

  private long startInNanos;
  private long stopInNanos;
  private final MetricKey metricKey;

  private static final String TAG = "SetupCompat.Timer";
}