org.sonar.java.reporting.FluentReporting Maven / Gradle / Ivy

Go to download
/*
 * SonarQube Java
 * Copyright (C) 2012-2023 SonarSource SA
 * mailto:info 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.java.reporting;

import java.util.List;
import org.sonar.java.annotations.Beta;
import org.sonar.plugins.java.api.JavaCheck;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.tree.Tree;

@Beta
public interface FluentReporting {

  JavaIssueBuilder newIssue();

  interface JavaIssueBuilder {
    JavaIssueBuilder forRule(JavaCheck rule);

    JavaIssueBuilder onTree(Tree tree);

    JavaIssueBuilder onRange(Tree from, Tree to);

    JavaIssueBuilder withMessage(String message);

    /**
     * Alias for java.lang.String.format(String, Object...)
     */
    JavaIssueBuilder withMessage(String message, Object... args);

    JavaIssueBuilder withSecondaries(JavaFileScannerContext.Location... secondaries);

    JavaIssueBuilder withSecondaries(List secondaries);

    JavaIssueBuilder withFlows(List> flows);

    JavaIssueBuilder withCost(int cost);

    void report();
  }
}