org.sonarsource.sonarlint.plugin.api.issue.NewQuickFix Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sonarlint-core Show documentation

Common library used by some SonarLint flavors

There is a newer version: 10.5.0.78949

/*
 * SonarLint Plugin API
 * Copyright (C) 2016-2022 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.sonarsource.sonarlint.plugin.api.issue;

/**
 * Describe a quick fix for a {@link NewSonarLintIssue}, with a description and a collection of {@link NewInputFileEdit}.
 * Input file edits will be applied in the order they are added, insofar that they are compatible with one another.
 * @since 6.3
 */
public interface NewQuickFix {

  /**
   * Define the message for this quick fix, which will be shown to the user as an action item.
   * A good message should:
   * 
   *   Be short (ideally, not more than 50 characters)
   *   Use sentence capitalization
   *   Not end with a full stop (.)
   * 
   * @param message a description for this quick fix
   * @return the updated quickfix
   */
  NewQuickFix message(String message);

  /**
   * Create a new input file edit
   * @return a new uninitialized instance of a file edit for a given fix
   */
  NewInputFileEdit newInputFileEdit();

  /**
   * Add a new input file edit to this quick fix
   * @param newInputFileEdit the input file edit to add
   * @return this instance
   */
  NewQuickFix addInputFileEdit(NewInputFileEdit newInputFileEdit);
}