001package org.apache.commons.jcs3.utils.timing;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * This is a simple timer utility.
024 */
025public class ElapsedTimer
026{
027    /** display suffix describing the unit of measure. */
028    private static final String SUFFIX = "ms.";
029
030    /**
031     * Sets the start time when created.
032     */
033    private long timeStamp = System.currentTimeMillis();
034
035    /**
036     * Gets the time elapsed between the start time and now. The start time is reset to now.
037     * Subsequent calls will get the time between then and now.
038     * <p>
039     * @return the elapsed time
040     */
041    public long getElapsedTime()
042    {
043        final long now = System.currentTimeMillis();
044        final long elapsed = now - timeStamp;
045        timeStamp = now;
046        return elapsed;
047    }
048
049    /**
050     * Returns the elapsed time with the display suffix.
051     * <p>
052     * @return formatted elapsed Time
053     */
054    public String getElapsedTimeString()
055    {
056        return String.valueOf( getElapsedTime() ) + SUFFIX;
057    }
058}