Stopwatch.java

/**
 * Copyright 2013 Netflix, Inc.
 * <p/>
 * 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
 * <p/>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p/>
 * 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 com.netflix.servo.monitor;

import java.util.concurrent.TimeUnit;

/**
 * Measures the time taken for execution of some code.
 */
public interface Stopwatch {

  /**
   * Mark the start time.
   */
  void start();

  /**
   * Mark the end time.
   */
  void stop();

  /**
   * Reset the stopwatch so that it can be used again.
   */
  void reset();

  /**
   * Returns the duration in the specified time unit.
   */
  long getDuration(TimeUnit timeUnit);

  /**
   * Returns the duration in nanoseconds.
   */
  long getDuration();
}