    001/**
    002 * Copyright (c) 2004-2011 QOS.ch
    003 * All rights reserved.
    004 *
    005 * Permission is hereby granted, free  of charge, to any person obtaining
    006 * a  copy  of this  software  and  associated  documentation files  (the
    007 * "Software"), to  deal in  the Software without  restriction, including
    008 * without limitation  the rights to  use, copy, modify,  merge, publish,
    009 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
    010 * permit persons to whom the Software  is furnished to do so, subject to
    011 * the following conditions:
    012 *
    013 * The  above  copyright  notice  and  this permission  notice  shall  be
    014 * included in all copies or substantial portions of the Software.
    015 *
    016 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
    017 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
    018 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
    019 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
    020 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
    021 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
    022 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
    023 *
    024 */
    025package org.slf4j.profiler;
    026
    027/**
    028 * This interface sets the methods that must be implemented by
    029 * {@link Profiler} and {@link  StopWatch} classes. It settles the
    030 * general feel of the profiler package.
    031 *
    032 * @author Ceki G&uuml;lc&uuml;
    033 *
    034 */
    035public interface TimeInstrument {
    036
    037    /**
    038     * All time instruments are named entities.
    039     * @return the name of this instrument
    040     */
    041    String getName();
    042
    043    TimeInstrumentStatus getStatus();
    044
    045    /**
    046     * Start this time instrument.
    047     *
    048     * @param name
    049     */
    050    void start(String name);
    051
    052    /**
    053     * Stop this time instrument.
    054     *
    055     * @return this
    056     */
    057    TimeInstrument stop();
    058
    059    /**
    060     * Time elapsed between start and stop, in nanoseconds.
    061     *
    062     * @return time elapsed in nanoseconds
    063     */
    064    long elapsedTime();
    065
    066    /**
    067     * Print information about this time instrument on the console.
    068     */
    069    void print();
    070
    071    /**
    072     * If the time instrument has an associated logger, then log information about
    073     * this time instrument. Note that {@link StopWatch} instances cannot log while {@link Profiler}
    074     * instances can.
    075     */
    076    void log();
    077}