blob: d3ca2b1e587551392baab6208b22fa3bde7a88f4 (
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
|
/*
* SonarQube, open source software quality management tool.
* Copyright (C) 2008-2013 SonarSource
* mailto:contact AT sonarsource DOT com
*
* SonarQube 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.
*
* SonarQube 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.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Property field.
*
* @since 3.3
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface PropertyField {
/**
* Unique key within a property. It shouldn't be prefixed.
* Settings for this field are stored into the database with a composite key
* <code>{key of parent property}.{key of the set}.{key of this field}</code>
* eg. <code>sonar.jira.servers.JIRA1.url</code>
*/
String key();
/**
* This name will be displayed on the Settings page. This can be overridden/translated
* by adding a a value for: <code>field.{key of parent property}.{key of this field}.name</code> in the language bundle.
*/
String name();
/**
* If not empty, this description will be displayed on the Settings page. This can be overridden/translated
* by adding a a value for: <code>field.{key of parent property}.{key of this field}.description</code> in the language bundle.
*/
String description() default "";
/**
* Indicative size of the field value in characters. This size is not validated, it is merely used by the GUI
* to size the different input fields of a property set.
*/
int indicativeSize() default 20;
PropertyType type() default PropertyType.STRING;
/**
* Options for *_LIST types
*/
String[] options() default {};
}
|
