org.sonar.server.computation.formula.CounterInitializationContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-server Show documentation

There is a newer version: 7.2.1

/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.server.computation.formula;

import com.google.common.base.Optional;
import java.util.List;
import org.sonar.server.computation.component.Component;
import org.sonar.server.computation.measure.Measure;
import org.sonar.server.computation.period.Period;

/**
 * The context passing information to {@link Counter#initialize(CounterInitializationContext)}.
 */
public interface CounterInitializationContext {

  /**
   * The Component representing the currently processed leaf.
   */
  Component getLeaf();

  /**
   * Retrieve the measure for the current component for the specified metric key if it exists.
   */
  Optional getMeasure(String metricKey);

  /**
   * Lists of Periods defined for the current project. They can be used to retrieve variations Measure.
   */
  List getPeriods();

}