Home | History | Annotate | Download | only in profiler 
      1 /**
      2  * Copyright (c) 2004-2011 QOS.ch
      3  * All rights reserved.
      4  *
      5  * Permission is hereby granted, free  of charge, to any person obtaining
      6  * a  copy  of this  software  and  associated  documentation files  (the
      7  * "Software"), to  deal in  the Software without  restriction, including
      8  * without limitation  the rights to  use, copy, modify,  merge, publish,
      9  * distribute,  sublicense, and/or sell  copies of  the Software,  and to
     10  * permit persons to whom the Software  is furnished to do so, subject to
     11  * the following conditions:
     12  *
     13  * The  above  copyright  notice  and  this permission  notice  shall  be
     14  * included in all copies or substantial portions of the Software.
     15  *
     16  * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
     17  * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
     18  * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
     19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     21  * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
     22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     23  *
     24  */
     25 package org.slf4j.profiler;
     26 
     27 /**
     28  * This interface sets the methods that must be implemented by
     29  * {@link Profiler} and {@link  StopWatch} classes. It settles the
     30  * general feel of the profiler package.
     31  *
     32  * @author Ceki Gülcü
     33  *
     34  */
     35 public interface TimeInstrument {
     36 
     37     /**
     38      * All time instruments are named entities.
     39      * @return the name of this instrument
     40      */
     41     String getName();
     42 
     43     TimeInstrumentStatus getStatus();
     44 
     45     /**
     46      * Start tis time instrument.
     47      *
     48      * @param name
     49      */
     50     void start(String name);
     51 
     52     /**
     53      * Stop this time instrument.
     54      *
     55      * @return this
     56      */
     57     TimeInstrument stop();
     58 
     59     /**
     60      * Time elapsed between start and stop, in nanoseconds.
     61      *
     62      * @return time elapsed in nanoseconds
     63      */
     64     long elapsedTime();
     65 
     66     /**
     67      * Print information about this time instrument on the console.
     68      */
     69     void print();
     70 
     71     /**
     72      * If the time instrument has an associated logger, then log information about
     73      * this time instrument. Note that {@link StopWatch} instances cannot log while {@link Profiler}
     74      * instances can.
     75      */
     76     void log();
     77 }
     78