source.dussan.org Git - sonarqube.git/blob

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2016 SonarSource SA
   4  * mailto:contact AT sonarsource DOT com
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  */
  20 package org.sonar.server.computation.task.projectanalysis.period;
  21
  22 import java.util.List;
  23
  24 /**
  25  * Repository of period used to compute differential measures.
  26  * Here are the steps to retrieve the period :
  27  * - Read the period property ${@link org.sonar.core.config.CorePropertyDefinitions#TIMEMACHINE_PERIOD_PREFIX}
  28  * - Try to find the matching snapshots from the property
  29  * - If a snapshot is found, the period is added to the repository
  30  */
  31 public interface PeriodsHolder {
  32
  33   @Deprecated
  34   int MAX_NUMBER_OF_PERIODS = 5;
  35
  36   /**
  37    * Return the list of differential periods, ordered by increasing index.
  38    *
  39    * @throws IllegalStateException if the periods haven't been initialized
  40    * @deprecated replaced by {@link #getPeriod()}
  41    */
  42   @Deprecated
  43   List<Period> getPeriods();
  44
  45   /**
  46    * Finds out whether the holder contains a Period for the specified index.
  47    *
  48    * @throws IllegalStateException if the periods haven't been initialized
  49    * @throws IndexOutOfBoundsException if i is either &lt; 1 or &gt; 5
  50    * @deprecated replaced by {@link #hasPeriod()}
  51    */
  52   @Deprecated
  53   boolean hasPeriod(int i);
  54
  55   /**
  56    * Retrieves the Period for the specified index from the Holder.
  57    *
  58    * @throws IllegalStateException if the periods haven't been initialized
  59    * @throws IllegalStateException if there is no period for the specified index (see {@link #hasPeriod(int)})
  60    * @throws IndexOutOfBoundsException if i is either &lt; 1 or &gt; 5
  61    * @deprecated replaced by {@link #getPeriod()}
  62    */
  63   @Deprecated
  64   Period getPeriod(int i);
  65
  66   /**
  67    * Finds out whether the holder contains a Period
  68    *
  69    * @throws IllegalStateException if the periods haven't been initialized
  70    */
  71   boolean hasPeriod();
  72
  73   /**
  74    * Retrieve the period from the Holder.
  75    *
  76    * @throws IllegalStateException if the periods haven't been initialized
  77    */
  78   Period getPeriod();
  79
  80 }