View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.monitoring.stopwatches;
19  
20  /**
21   * Instrumentation tool to compute resource consumption of some code fragment execution.
22   * <p/>
23   * StopWatch implementation is supposed not to be thread-safe and to be a one-shot tool. Don't
24   * share it beetween threads, don't try to reuse it.
25   *
26   * @author <a href="mailto:nicolas@apache.org">Nicolas De Loof</a>
27   */
28  public interface StopWatch {
29      long getElapsedTime();
30  
31      StopWatch stop();
32  }