etm.core.timer.DefaultTimer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jetm
The Java Execution Time Measurement Library core package
There is a newer version: 1.2.3
/*
 *
 * Copyright (c) 2004, 2005, 2006, 2007 void.fm
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list
 * of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice, this
 * list of conditions and the following disclaimer in the documentation and/or
 * other materials provided with the distribution.
 *
 * Neither the name void.fm nor the names of its contributors may be
 * used to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

package etm.core.timer;

import etm.core.metadata.TimerMetaData;

/**
 * The DefaultTimer uses System.currentTimeMillis() and will provide fairly
 * coarse grained statistics on the Windows(TM) platform. Don't use this timer
 * on this platform if possible.
 *
 * @author void.fm
 * @version $Revision: 35 $
 */

public class DefaultTimer implements ExecutionTimer {
  private static final long DEFAULT_TICKS_PER_SECOND = 1000L;
  private static final String DESCRIPTION = "Java VM System.currentTimeMillis()";

  public DefaultTimer() {
    if (System.getProperty("os.name").indexOf("Win") >= 0) {
      System.err.println("Windows OS detected. Measurements lower than 10ms not supported by this platform.");
    }
  }

  public long getCurrentTime() {
    return System.currentTimeMillis();
  }

  public long getTicksPerSecond() {
    return DEFAULT_TICKS_PER_SECOND;
  }


  public String toString() {
    return getClass().getName();
  }

  public TimerMetaData getMetaData() {
    return new TimerMetaData(DefaultTimer.class,
      DESCRIPTION,
      getTicksPerSecond()
    );
  }
}