PerformanceTestCase.java revision 2395179afb2ea957a9ba66404021c14160361611 
1/*
2 * Copyright (C) 2006 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
17package android.test;
18
19/**
20 * More complex interface performance for test cases.
21 *
22 * If you want your test to be used as a performance test, you must
23 * implement this interface.
24 */
25@Deprecated
26public interface PerformanceTestCase
27{
28    /**
29     * Callbacks for {@link PerformanceTestCase}.
30     */
31    public interface Intermediates
32    {
33        void setInternalIterations(int count);
34        void startTiming(boolean realTime);
35        void addIntermediate(String name);
36        void addIntermediate(String name, long timeInNS);
37        void finishTiming(boolean realTime);
38    }
39
40    /**
41     * Set up to begin performance tests. The 'intermediates' is a
42     * communication channel to send back intermediate performance numbers --
43     * if you use it, you will probably want to ensure your test is only
44     * executed once by returning 1.  Otherwise, return 0 to allow the test
45     * harness to decide the number of iterations.
46     *
47     * <p>If you return a non-zero iteration count, you should call
48     * {@link Intermediates#startTiming intermediates.startTiming} and
49     * {@link Intermediates#finishTiming intermediates.endTiming} to report the
50     * duration of the test whose performance should actually be measured.
51     *
52     * @param intermediates Callback for sending intermediate results.
53     *
54     * @return int Maximum number of iterations to run, or 0 to let the caller
55     * decide.
56     */
57    int startPerformance(Intermediates intermediates);
58
59    /**
60     * This method is used to determine what modes this test case can run in.
61     *
62     * @return true if this test case can only be run in performance mode.
63     */
64    boolean isPerformanceOnly();
65}
66
67