001/*
002 * SonarQube, open source software quality management tool.
003 * Copyright (C) 2008-2013 SonarSource
004 * mailto:contact AT sonarsource DOT com
005 *
006 * SonarQube is free software; you can redistribute it and/or
007 * modify it under the terms of the GNU Lesser General Public
008 * License as published by the Free Software Foundation; either
009 * version 3 of the License, or (at your option) any later version.
010 *
011 * SonarQube is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014 * Lesser General Public License for more details.
015 *
016 * You should have received a copy of the GNU Lesser General Public License
017 * along with this program; if not, write to the Free Software Foundation,
018 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019 */
020package org.sonar.api.utils;
021
022import org.slf4j.Logger;
023import org.slf4j.LoggerFactory;
024
025/**
026 * A very simple profiler to log the time elapsed performing some tasks.
027 * This implementation is not thread-safe.
028 *
029 * @since 2.0
030 */
031public class TimeProfiler {
032
033  private Logger logger;
034  private long start = 0;
035  private String name;
036  private boolean debug = false;
037
038  public TimeProfiler(Logger logger) {
039    this.logger = logger;
040  }
041
042  public TimeProfiler(Class clazz) {
043    this.logger = LoggerFactory.getLogger(clazz);
044  }
045
046  /**
047   * Use the default Sonar logger
048   */
049  public TimeProfiler() {
050    this.logger = Logs.INFO;
051  }
052
053  public TimeProfiler start(String name) {
054    this.name = name;
055    this.start = System.currentTimeMillis();
056    if (debug) {
057      logger.debug(name + "...");
058    } else {
059      logger.info(name + "...");
060    }
061    return this;
062  }
063
064  public TimeProfiler setLogger(Logger logger) {
065    this.logger = logger;
066    return this;
067  }
068
069  public Logger getLogger() {
070    return logger;
071  }
072
073  /**
074   * @since 2.4
075   */
076  public TimeProfiler setLevelToDebug() {
077    debug = true;
078    return this;
079  }
080
081  public TimeProfiler stop() {
082    if (start > 0) {
083      String format = "{} done: {} ms";
084      if (debug) {
085        logger.debug(format, name, System.currentTimeMillis() - start);
086      } else {
087        logger.info(format, name, System.currentTimeMillis() - start);
088      }
089    }
090    start = 0;
091    return this;
092  }
093}