View Javadoc
1   package org.apache.commons.jcs3.utils.timing;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  /**
23   * This is a simple timer utility.
24   */
25  public class ElapsedTimer
26  {
27      /** display suffix describing the unit of measure. */
28      private static final String SUFFIX = "ms.";
29  
30      /**
31       * Sets the start time when created.
32       */
33      private long timeStamp = System.currentTimeMillis();
34  
35      /**
36       * Gets the time elapsed between the start time and now. The start time is reset to now.
37       * Subsequent calls will get the time between then and now.
38       * <p>
39       * @return the elapsed time
40       */
41      public long getElapsedTime()
42      {
43          final long now = System.currentTimeMillis();
44          final long elapsed = now - timeStamp;
45          timeStamp = now;
46          return elapsed;
47      }
48  
49      /**
50       * Returns the elapsed time with the display suffix.
51       * <p>
52       * @return formatted elapsed Time
53       */
54      public String getElapsedTimeString()
55      {
56          return String.valueOf( getElapsedTime() ) + SUFFIX;
57      }
58  }