001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     *
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     *
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    
018    package org.apache.commons.monitoring.stopwatches;
019    
020    /**
021     * Instrumentation tool to compute resource consumption of some code fragment execution.
022     * <p/>
023     * StopWatch implementation is supposed not to be thread-safe and to be a one-shot tool. Don't
024     * share it beetween threads, don't try to reuse it.
025     *
026     * @author <a href="mailto:nicolas@apache.org">Nicolas De Loof</a>
027     */
028    public interface StopWatch {
029        long getElapsedTime();
030    
031        StopWatch stop();
032    }