aboutsummaryrefslogtreecommitdiff
path: root/common/src/com/android/tv/common/util/DurationTimer.java
blob: 91581ad574f237006490683665213b05ece20765 (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
/*
 * Copyright (C) 2015 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.android.tv.common.util;

import android.os.SystemClock;
import android.util.Log;
import com.android.tv.common.BuildConfig;

/** Times a duration. */
public final class DurationTimer {
    private static final String TAG = "DurationTimer";
    public static final long TIME_NOT_SET = -1;

    private long mStartTimeMs = TIME_NOT_SET;
    private String mTag = TAG;
    private boolean mLogEngOnly;

    public DurationTimer() {}

    public DurationTimer(String tag, boolean logEngOnly) {
        mTag = tag;
        mLogEngOnly = logEngOnly;
    }

    /** Returns true if the timer is running. */
    public boolean isRunning() {
        return mStartTimeMs != TIME_NOT_SET;
    }

    /** Start the timer. */
    public void start() {
        mStartTimeMs = SystemClock.elapsedRealtime();
    }

    /** Returns true if timer is started. */
    public boolean isStarted() {
        return mStartTimeMs != TIME_NOT_SET;
    }

    /**
     * Returns the current duration in milliseconds or {@link #TIME_NOT_SET} if the timer is not
     * running.
     */
    public long getDuration() {
        return isRunning() ? SystemClock.elapsedRealtime() - mStartTimeMs : TIME_NOT_SET;
    }

    /**
     * Stops the timer and resets its value to {@link #TIME_NOT_SET}.
     *
     * @return the current duration in milliseconds or {@link #TIME_NOT_SET} if the timer is not
     *     running.
     */
    public long reset() {
        long duration = getDuration();
        mStartTimeMs = TIME_NOT_SET;
        return duration;
    }

    /** Adds information and duration time to the log. */
    public void log(String message) {
        if (isRunning() && (!mLogEngOnly || BuildConfig.ENG)) {
            Log.i(mTag, message + " : " + getDuration() + "ms");
        }
    }
}