19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.test; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * More complex interface performance for test cases. 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * If you want your test to be used as a performance test, you must 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * implement this interface. 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic interface PerformanceTestCase 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project{ 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Callbacks for {@link PerformanceTestCase}. 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface Intermediates 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project { 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void setInternalIterations(int count); 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void startTiming(boolean realTime); 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void addIntermediate(String name); 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void addIntermediate(String name, long timeInNS); 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project void finishTiming(boolean realTime); 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set up to begin performance tests. The 'intermediates' is a 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * communication channel to send back intermediate performance numbers -- 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * if you use it, you will probably want to ensure your test is only 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executed once by returning 1. Otherwise, return 0 to allow the test 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * harness to decide the number of iterations. 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>If you return a non-zero iteration count, you should call 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Intermediates#startTiming intermediates.startTiming} and 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Intermediates#finishTiming intermediates.endTiming} to report the 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * duration of the test whose performance should actually be measured. 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intermediates Callback for sending intermediate results. 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return int Maximum number of iterations to run, or 0 to let the caller 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * decide. 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project int startPerformance(Intermediates intermediates); 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This method is used to determine what modes this test case can run in. 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return true if this test case can only be run in performance mode. 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean isPerformanceOnly(); 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 66