001    /*
002     * Sonar, open source software quality management tool.
003     * Copyright (C) 2009 SonarSource SA
004     * mailto:contact AT sonarsource DOT com
005     *
006     * Sonar 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     * Sonar 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
017     * License along with Sonar; if not, write to the Free Software
018     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
019     */
020    package org.sonar.api.utils;
021    
022    import org.slf4j.Logger;
023    import 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     */
031    public class TimeProfiler {
032    
033      private Logger logger;
034      private long start = 0;
035      private String name;
036    
037      public TimeProfiler(Logger logger) {
038        this.logger = logger;
039      }
040    
041      public TimeProfiler(Class clazz) {
042        this.logger = LoggerFactory.getLogger(clazz);
043      }
044    
045      /**
046       * Use the default Sonar logger
047       */
048      public TimeProfiler() {
049        this.logger = Logs.INFO;
050      }
051    
052      public TimeProfiler start(String name) {
053        this.name = name;
054        this.start = System.currentTimeMillis();
055        logger.info(name + "...");
056        return this;
057      }
058    
059      public TimeProfiler setLogger(Logger logger) {
060        this.logger = logger;
061        return this;
062      }
063    
064      public Logger getLogger() {
065        return logger;
066      }
067    
068      public TimeProfiler stop() {
069        if (start > 0) {
070          logger.info("{} done: {} ms", name, (System.currentTimeMillis() - start));
071        }
072        start = 0;
073        return this;
074      }
075    }