/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowledgement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgement may appear in the software itself,
 *    if and wherever such third-party acknowledgements normally appear.
 *
 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package org.apache.commons.lang.time;

/**
 * <p><code>StopWatch</code> は時間調整のための簡易APIを提供します。
 * {@primary <code>StopWatch</code> provides a convenient API for timings.}</p>
 * 
 * <p>このクラスのメソッドは不適当な要求に対する防御措置を行いません。
 * 従って start の前に stop 、 suspend の前に resume 、 split の前に unsplit を呼ぶことが出来てしまいます。
 * このような場合の結果は不確定です。
 * {@primary The methods do <b>not</b> protect against inappropriate calls. Thus you
 * can call stop before start, resume before suspend or unsplit before split.
 * The results are indeterminate in these cases.}</p>
 * 
 * <p>ストップウォッチをスタートさせるには {@link #start()} をコールします。
 * その後、以下の事をすることが出来ます:
 * {@primary To start the watch, call {@link #start()}. At this point you can:}</p>
 * <ul>
 *  <li>{@link #split()} これまでの時間を取得してストップウォッチはバックグラウンドで動作しつづけます。
 *   {@link #unsplit()} は split の結果を削除し、split、suspend、stop の処理を再び有効にします。
 *   {@primary {@link #split()} the watch to get the time whilst the watch continues in the
 *   background. {@link #unsplit()} will remove the effect of the split. At this point,
 *   these three options are available again.}</li>
 *  <li>{@link #suspend()} ストップウォッチを一時停止します。{@link #resume()} にてストップウォッチの動作を再開します。
 *   suspend と resume の間の時間はトータルの時間には含まれません。
 *   resume の後、split、suspend、stop の処理が再び有効になります。
 *   {@primary {@link #suspend()} the watch to pause it. {@link #resume()} allows the watch
 *   to continue. Any time between the suspend and resume will not be counted in
 *   the total. At this point, these three options are available again.}</li>
 *  <li>{@link #stop()} 一連のタイムウォッチの処理を完了します。
 *   {@primary {@link #stop()} the watch to complete the timing session.}</li>
 * </ul>
 *
 * <p>出力メソッド {@link #toString()} と {@link #getTime()} は stop、 split、 suspend 
 * の後に呼ばれることを意図していますが、他の状態で呼ばれても適切な結果を返します。
 * {@primary It is intended that the output methods {@link #toString()} and {@link #getTime()}
 * should only be called after stop, split or suspend, however a suitable result will
 * be returned at other points.}</p>
 *
 * @author Henri Yandell
 * @author Stephen Colebourne
 * @translator 日置 聡
 * @status firstdraft
 * @update 2003/09/21
 * @memo 2.0新規
 * @since 2.0
 * @version $Id: StopWatch.java,v 1.1.1.1 2004/02/13 10:02:05 hioki Exp $
 */
public class StopWatch {
    
    /**
     * 開始時間です。{@primary The start time.}
     */
    private long startTime = -1;
    /**
     * 終了時間です。{@primary The stop time.}
     */
    private long stopTime = -1;

    /**
     * <p>コンストラクタです。{@primary Constructor.}</p>
     */
    public StopWatch() {
    }

    /**
     * <p>ストップウォッチをスタートします。{@primary Start the stopwatch.}</p>
     * 
     * <p>このメソッドは以前の値をクリアし、新たな処理のセッションを開始します。
     * {@primary This method starts a new timing session, clearing any previous values.}</p>
     */
    public void start() {
        stopTime = -1;
        startTime = System.currentTimeMillis();
    }

    /**
     * <p>ストップウォッチをストップします。{@primary Stop the stopwatch.}</p>
     * 
     * <p>このメソッドは処理のセッションを終了し、時間の結果を取得できるようにします。
     * {@primary This method ends a new timing session, allowing the time to be retrieved.}</p>
     */
    public void stop() {
        stopTime = System.currentTimeMillis();
    }

    /**
     * <p>ストップウォッチをリセットします。{@primary Reset the stopwatch.}</p>
     * 
     * <p>このメソッドは内部の値をクリアし、このオブジェクトを再利用可能にします。
     * {@primary This method clears the internal values to allow the object to be reused.}</p>
     */
    public void reset() {
        startTime = -1;
        stopTime = -1;
    }

    /**
     * <p>途中時間を取得します。{@primary Split the time.}</p>
     * 
     * <p>このメソッドはストップウォッチの停止時間を設定し時間の結果を取得できるようにします。
     * 開始時間には影響を与えないため、{@link #unsplit()}
     * を呼ぶことによりストップウォッチの処理を再開することが出来ます。
     * {@primary This method sets the stop time of the watch to allow a time to be extracted.
     * The start time is unaffected, enabling {@link #unsplit()} to contine the 
     * timing from the original start point.}</p>
     */
    public void split() {
        stopTime = System.currentTimeMillis();
    }

    /**
     * <p>途中時間を削除します。{@primary Remove a split.}</p>
     * 
     * <p>このメソッドは停止時間をクリアします。
     * 開始時間には影響を与えないためストップウォッチの処理を再開することが出来ます。
     * {@primary This method clears the stop time. The start time is unaffected, enabling 
     * timing from the original start point to continue.}</p>
     */
    public void unsplit() {
        stopTime = -1;
    }

    /**
     * <p>再開されるまでストップウォッチを一時停止します。{@primary Suspend the stopwatch for later resumption.}</p>
     * 
     * <p>このメソッドは再開されるまでストップウォッチを一時停止します。
     * ストップウォッチは suspend と resume の間の時間をトータルの時間に含めません。
     * {@primary This method suspends the watch until it is resumed. The watch will not include
     * time between the suspend and resume calls in the total time.}</p>
     */
    public void suspend() {
        stopTime = System.currentTimeMillis();
    }

    /**
     * <p>一時停止されているストップウォッチの動作を再開します。
     * {@primary Resume the stopwatch after a suspend.}</p>
     * 
     * <p>このメソッドは一時停止されているストップウォッチの動作を再開します。
     * ストップウォッチは suspend と resume の間の時間をトータルの時間に含めません。
     * {@primary This method resumes the watch after it was suspended. The watch will not include
     * time between the suspend and resume calls in the total time.}</p>
     */
    public void resume() {
        startTime += (System.currentTimeMillis() - stopTime);
        stopTime = -1;
    }

    /**
     * <p>ストップウォッチの経過時間を取得します。{@primary Get the time on the stopwatch.}</p>
     * 
     * <p>これは、start と最後の split との間、 start と end の間、
     * start とこのメソッドが呼ばれたタイミングの間のいずれかになります。
     * {@primary This is either the time between start and latest split, between start
     * and stop, or the time between the start and the moment this method is called.}</p>
     * 
     * @return ミリセカンドで表現された時間{@primary the time in milliseconds}
     */
    public long getTime() {
        if (stopTime == -1) {
            if (startTime == -1) {
                return 0;
            }
            return (System.currentTimeMillis() - this.startTime);
        }
        return (this.stopTime - this.startTime);
    }

    /**
     * <p>ストップウォッチが計測した時間の概要の文字列表現を取得します。
     * {@primary Gets a summary of the time that the stopwatch recorded as a string.}</p>
     * 
     * <p>ISO8601 に近い、
     * <i>時間</i>:<i>分</i>:<i>秒</i>.<i>ミリ秒</i>
     * のフォーマットが使用されます。
     * {@primary The format used is ISO8601-like,
     * <i>hours</i>:<i>minutes</i>:<i>seconds</i>.<i>milliseconds</i>.}</p>
     * 
     * @return 計測時間を示す String{@primary the time as a String}
     */
    public String toString() {
        return DurationFormatUtils.formatISO(getTime());
    }

}