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

   1 /*
   2  * SonarQube
   3  * Copyright (C) 2009-2021 SonarSource SA
   4  * mailto:info 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.ce.task.projectanalysis.metric;
  21
  22 import java.util.Optional;
  23
  24 public interface MetricRepository {
  25
  26   /**
  27    * Gets the {@link Metric} with the specific key.
  28    * <p>Since it does not make sense to encounter a reference (ie. a key) to a Metric during processing of
  29    * a new analysis and not finding it in DB (metrics are never deleted), this method will throw an
  30    * IllegalStateException if the metric with the specified key can not be found.</p>
  31    *
  32    * @throws IllegalStateException if no Metric with the specified key is found
  33    * @throws NullPointerException if the specified key is {@code null}
  34    */
  35   Metric getByKey(String key);
  36
  37   /**
  38    * Gets the {@link Metric} with the specific uuid.
  39    *
  40    * @throws IllegalStateException if no Metric with the specified uuid is found
  41    */
  42   Metric getByUuid(String uuid);
  43
  44   /**
  45    * Gets the {@link Metric} with the specific uuid if it exists in the repository.
  46    */
  47   Optional<Metric> getOptionalByUuid(String uuid);
  48
  49   /**
  50    * Get iterable of all {@link Metric}.
  51    */
  52   Iterable<Metric> getAll();
  53
  54 }