1 /*
2  * Copyright (C) 2022 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.adservices.service.profiling;
18 
19 /** Profiler class for timing/benchmarking classes. */
20 public class Profiler {
21     private final String mTag;
22     private boolean mIsTestEnv;
23 
24     /** For use in test environments. */
createInstance(String tag)25     public static Profiler createInstance(String tag) {
26         return new Profiler(tag, false);
27     }
28 
29     /** For use in non-test environments. */
createNoOpInstance(String tag)30     public static Profiler createNoOpInstance(String tag) {
31         return new Profiler(tag, true);
32     }
33 
Profiler(String tag, boolean isTestEnv)34     private Profiler(String tag, boolean isTestEnv) {
35         mTag = tag;
36         mIsTestEnv = isTestEnv;
37     }
38 
39     /** @param name name of the metric being measured */
start(String name)40     public StopWatch start(String name) {
41         return mIsTestEnv ? new FakeStopWatch() : new LogcatStopWatch(mTag, name);
42     }
43 }
44