001/*
002 * SonarQube
003 * Copyright (C) 2009-2017 SonarSource SA
004 * mailto:info AT sonarsource DOT com
005 *
006 * This program 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 * This program 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
022/**
023 * @since 3.6
024 */
025public final class TimeUtils {
026
027  private TimeUtils() {
028  }
029
030  /**
031   * Label for a duration, expressed in numbers of ms, seconds or minutes.
032   * <br>
033   * Examples:
034   * <ul>
035   *   <li>10 -&gt; "10ms"</li>
036   *   <li>100 -&gt; "100ms"</li>
037   *   <li>10000 -&gt; "10s"</li>
038   *   <li>100000 -&gt; "1min 40s"</li>
039   * </ul>
040   */
041  public static String formatDuration(long durationInMs) {
042    if (durationInMs < 1000) {
043      return String.format("%sms", durationInMs);
044    } else {
045      long sec = durationInMs / 1000;
046      if (sec < 60) {
047        return String.format("%ss", sec);
048      } else {
049        long min = sec / 60;
050        long remainingSec = sec - (min * 60);
051        if (remainingSec > 0) {
052          return String.format("%smin %ss", min, remainingSec);
053        } else {
054          return String.format("%smin", min);
055        }
056      }
057    }
058  }
059}