Home | History | Annotate | Download | only in test 
      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 
     17 package 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 Use
     26  * <a href="{@docRoot}reference/android/support/test/runner/AndroidJUnitRunner.html">
     27  * AndroidJUnitRunner</a> instead. New tests should be written using the
     28  * <a href="{@docRoot}tools/testing-support-library/index.html">Android Testing Support Library</a>.
     29  */
     30 @Deprecated
     31 public interface PerformanceTestCase
     32 {
     33     /**
     34      * Callbacks for {@link PerformanceTestCase}.
     35      */
     36     public interface Intermediates
     37     {
     38         void setInternalIterations(int count);
     39         void startTiming(boolean realTime);
     40         void addIntermediate(String name);
     41         void addIntermediate(String name, long timeInNS);
     42         void finishTiming(boolean realTime);
     43     }
     44 
     45     /**
     46      * Set up to begin performance tests. The 'intermediates' is a
     47      * communication channel to send back intermediate performance numbers --
     48      * if you use it, you will probably want to ensure your test is only
     49      * executed once by returning 1.  Otherwise, return 0 to allow the test
     50      * harness to decide the number of iterations.
     51      *
     52      * <p>If you return a non-zero iteration count, you should call
     53      * {@link Intermediates#startTiming intermediates.startTiming} and
     54      * {@link Intermediates#finishTiming intermediates.endTiming} to report the
     55      * duration of the test whose performance should actually be measured.
     56      *
     57      * @param intermediates Callback for sending intermediate results.
     58      *
     59      * @return int Maximum number of iterations to run, or 0 to let the caller
     60      * decide.
     61      */
     62     int startPerformance(Intermediates intermediates);
     63 
     64     /**
     65      * This method is used to determine what modes this test case can run in.
     66      *
     67      * @return true if this test case can only be run in performance mode.
     68      */
     69     boolean isPerformanceOnly();
     70 }
     71 
     72