org.sonar.api
Annotation Type Property

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface Property

Property value can be set in different ways :

• System property
• Maven command-line (-Dfoo=bar)
• Maven pom.xml (element )
• Maven settings.xml
• Sonar web interface

Value is accessible in batch extensions via the Configuration object of class org.sonar.api.resources.Project (see method getConfiguration()).

Must be used in org.sonar.api.Plugin classes only.

Since:

1.10

Required Element Summary

java.lang.String	key Unique key within all plugins.
java.lang.String	name

Optional Element Summary

java.lang.String	defaultValue
java.lang.String	description
boolean	global Is the property displayed in global settings page ?
boolean	module Is the property displayed in module settings page ? A module is a maven sub-project.
boolean	project Is the property displayed in projet settings page ?

Element Detail

key

public abstract java.lang.String key

Unique key within all plugins. It's recommended to prefix the key by 'sonar.' and the plugin name. Examples : 'sonar.cobertura.reportPath' and 'sonar.cpd.minimumTokens'.

name

public abstract java.lang.String name

defaultValue

public abstract java.lang.String defaultValue

Default:

""

description

public abstract java.lang.String description

Default:

""

project

public abstract boolean project

Is the property displayed in projet settings page ?

Default:

false

module

public abstract boolean module

Is the property displayed in module settings page ? A module is a maven sub-project.

Default:

false

global

public abstract boolean global

Is the property displayed in global settings page ?

Default:

true