org.sonar.api
Interface Plugin

public interface Plugin

A plugin is a group of extensions.

Extension points on batch side :

• Sensors. See org.sonar.api.Sensor.
• Resource decorators. See org.sonar.api.Decorator.
• Jobs to purge database. See org.sonar.api.Purge

Extension points on server side :

• Dashboard widgets
• Charts
• Pages
• Code viewers

Global extension points

• Metrics
• Coding rules

A plugin can implement ProjectPredicate in order to be executed on some projects only. This interface is not used on server-side extensions like widgets.

Method Summary

java.lang.String	getDescription() description of the plugin, can contains html or ruby code
java.util.List<java.lang.Class<? extends Extension>>	getExtensions() Classes of the extensions to instantiate.
java.lang.String	getKey() Unique key within sonar providers
java.lang.String	getName() Descriptive name

Method Detail

getKey

java.lang.String getKey()

Unique key within sonar providers

getName

java.lang.String getName()

Descriptive name

getDescription

java.lang.String getDescription()

description of the plugin, can contains html or ruby code

getExtensions

java.util.List<java.lang.Class<? extends Extension>> getExtensions()

Classes of the extensions to instantiate.