alvinalexander.com | career | drupal | java | mac | mysql | perl | scala | uml | unix  

What this is

This file is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Other links

The source code

// $Header: /home/cvs/jakarta-jmeter/src/jorphan/org/apache/jorphan/timer/ITimer.java,v 1.3 2004/02/11 23:57:23 sebb Exp $
/*
 * Copyright 2002-2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
*/

package org.apache.jorphan.timer;

/**
 * A simple interface for measuring time intervals. An instance of this goes
 * through the following lifecycle states:
 * 
*
ready
*
timer is ready to start a new measurement
*
started
*
timer has recorded the starting time interval point
*
stopped
*
timer has recorded the ending time interval point
*
* See individual methods for details. *

* If this library has been compiled with * {@link ITimerConstants#DO_STATE_CHECKS} set to 'true' the implementation * will enforce this lifecycle model and throw IllegalStateException when it * is violated. * * @author Vlad Roubtsov * @author Originally published in JavaWorld * @version $Revision: 1.3 $ */ public interface ITimer { /** * Starts a new time interval and advances this timer instance to 'started' * state. This method can be called from 'ready' state only. */ void start (); /** * Terminates the current time interval and advances this timer instance to * 'stopped' state. Interval duration will be available via * {@link #getDuration()} method. This method can be called from 'started' * state only. */ void stop (); /** * Returns the duration of the time interval that elapsed between the last * calls to {@link #start()} and {@link #stop()}. This method can be called * any number of times from 'stopped' state and will return the same value * each time. * * @return interval duration in milliseconds */ double getDuration (); /** * This method can be called from any state and will reset this timer * instance back to 'ready' state. */ void reset (); }

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller

 

new blog posts

 

Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.