All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.sonar.api.batch.sensor.rule.AdHocRule Maven / Gradle / Ivy

There is a newer version: 10.5.0.78949
Show newest version
/*
 * SonarQube
 * Copyright (C) 2009-2021 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.api.batch.sensor.rule;

import javax.annotation.CheckForNull;
import org.sonar.api.batch.rule.Severity;
import org.sonar.api.batch.sensor.Sensor;
import org.sonar.api.rules.RuleType;

/**
 * Represents a rule imported from an external rule engine by a {@link Sensor}.
 * @since 7.4
 */
public interface AdHocRule {

  /**
   * Unique identifier of the external analyzer (e.g. eslint, pmd, ...)
   */
  String engineId();

  /**
   * Unique rule identifier for a given {@link #engineId()}
   */
  String ruleId();

  /**
   * Name of the rule.
   */
  String name();

  /**
   * Description of the rule.
   */
  @CheckForNull
  String description();

  /**
   * Default severity of the rule.
   */
  Severity severity();

  /**
   * Type of the rule.
   */
  RuleType type();

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy