org.sonar.api.SonarPlugin Maven / Gradle / Ivy

Go to download

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

Plugin API for SonarQube, SonarCloud and SonarLint

There is a newer version: 10.14.0.2599

/*
 * Sonar Plugin API
 * Copyright (C) 2009-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.sonar.api;

import java.util.List;

/**
 * Plugin entry-point used to declare its extensions (see {@link org.sonar.api.Extension}.
 * 

 * The JAR manifest must declare the name of the implementation class in the property Plugin-Class.
 * This property is automatically set by sonar-packaging-maven-plugin when building plugin.
 * 
 * @since 2.8
 * @deprecated replaced by {@link Plugin} in version 5.6.
 */
@Deprecated
public abstract class SonarPlugin implements Plugin {

  /**
   * Classes of the implemented extensions.
   */
  public abstract List getExtensions();

  /**
   * Returns a string representation of the plugin, suitable for debugging purposes only.
   */
  @Override
  public String toString() {
    return getClass().getSimpleName();
  }

  @Override
  public void define(Context context) {
    context.addExtensions(getExtensions());
  }
}