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.measures;
021
022import java.util.List;
023
024/**
025 * @since 3.0
026 * @deprecated since 5.2. Aggregation of measures is provided by {@link org.sonar.api.ce.measure.MeasureComputer}. {@link org.sonar.api.batch.Decorator}
027 * and {@link Formula} are no more supported.
028 */
029@Deprecated
030public class AverageFormula implements Formula {
031
032  /**
033   * Creates a new {@link AverageFormula} class.
034   *
035   * @param main The metric on which average should be calculated (ex.: "complexity")
036   * @param by   The metric used to divide the main metric to compute average (ex.: "file" for "complexity by file")
037   */
038  public static AverageFormula create(Metric main, Metric by) {
039    return new AverageFormula();
040  }
041
042  /**
043   * Set a fallback metric if no measures found for the main metric.
044   *
045   * @param fallbackMetric The fallback metric
046   * @since 3.6
047   */
048  public AverageFormula setFallbackForMainMetric(Metric fallbackMetric) {
049    throw fail();
050  }
051
052  /**
053   * {@inheritDoc}
054   */
055  @Override
056  public List<Metric> dependsUponMetrics() {
057    throw fail();
058  }
059
060  /**
061   * {@inheritDoc}
062   */
063  @Override
064  public Measure calculate(FormulaData data, FormulaContext context) {
065    throw fail();
066  }
067
068  private static RuntimeException fail() {
069    throw new UnsupportedOperationException("Unsupported since version 5.2. Decorators and formulas are not used anymore for aggregation measures. " +
070      "Please use org.sonar.api.ce.measure.MeasureComputer.");
071  }
072}