blob: 02f38d19331076ad970c7bc6f4a8eb0b116bbfd3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
/*
* Sonar, open source software quality management tool.
* Copyright (C) 2008-2011 SonarSource
* mailto:contact AT sonarsource DOT com
*
* Sonar 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.
*
* Sonar 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 Sonar; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02
*/
package org.sonar.api;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Property value can be set in different ways :
* <ul>
* <li>System property</li>
* <li>Maven command-line (-Dfoo=bar)</li>
* <li>Maven pom.xml (element <properties>)</li>
* <li>Maven settings.xml</li>
* <li>Sonar web interface</li>
* </ul>
* <p/>
* Value is accessible in batch extensions via the Configuration object of class <code>org.sonar.api.resources.Project</code>
* (see method <code>getConfiguration()</code>).
* <p/>
* <p><strong>Must be used in <code>org.sonar.api.Plugin</code> classes only.</strong></p>
*
* @since 1.10
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Property {
/**
* 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'.
*/
String key();
String defaultValue() default "";
String name();
String description() default "";
/**
* @since 2.11
*/
String category() default "";
/**
* Is the property displayed in projet settings page ?
*/
boolean project() default false;
/**
* Is the property displayed in module settings page ? A module is a maven sub-project.
*/
boolean module() default false;
/**
* Is the property displayed in global settings page ?
*/
boolean global() default true;
}
|
