Home | History | Annotate | Download | only in profiler
      1 /*
      2  * Copyright (C) 2015 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.camera.stats.profiler;
     18 
     19 /**
     20  * A profile is the primary mechanism used to start, stop,
     21  * and mark the duration of various things within a method.
     22  */
     23 public interface Profile {
     24     /**
     25      * Start, or restart the timers associated with
     26      * instance
     27      */
     28     public Profile start();
     29 
     30     /**
     31      * Mark an empty event at the current time.
     32      */
     33     public void mark();
     34 
     35     /**
     36      * Mark something at the current time.
     37      */
     38     public void mark(String reason);
     39 
     40     /**
     41      * Stop the profile.
     42      */
     43     public void stop();
     44 
     45     /**
     46      * Stop the profile for a given reason.
     47      */
     48     public void stop(String reason);
     49 }
     50