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.analysis;
  21
  22 import java.util.Map;
  23 import javax.annotation.CheckForNull;
  24 import org.sonar.server.computation.task.projectanalysis.qualityprofile.QualityProfile;
  25
  26 public interface AnalysisMetadataHolder {
  27
  28   /**
  29    * Returns the UUID generated for this analysis.
  30    * @throws IllegalStateException if uuid has not been set
  31    */
  32   String getUuid();
  33
  34   /**
  35    * @throws IllegalStateException if no analysis date has been set
  36    */
  37   long getAnalysisDate();
  38
  39   /**
  40    * Convenience method equivalent to calling {@link #getBaseProjectSnapshot() == null}
  41    *
  42    * @throws IllegalStateException if baseProjectSnapshot has not been set
  43    */
  44   boolean isFirstAnalysis();
  45
  46   /**
  47    * Return the last snapshot of the project.
  48    * If it's the first analysis, it will return null.
  49    *
  50    * @throws IllegalStateException if baseProjectSnapshot has not been set
  51    */
  52   @CheckForNull
  53   Analysis getBaseProjectSnapshot();
  54
  55   /**
  56    * @throws IllegalStateException if cross project duplication flag has not been set
  57    */
  58   boolean isCrossProjectDuplicationEnabled();
  59
  60   /**
  61    * @throws IllegalStateException if branch has not been set
  62    */
  63   @CheckForNull
  64   String getBranch();
  65
  66   /**
  67    * @throws IllegalStateException if root component ref has not been set
  68    */
  69   int getRootComponentRef();
  70
  71   Map<String, QualityProfile> getQProfilesByLanguage();
  72
  73 }