|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Retention(value=RUNTIME) @Target(value=TYPE) public @interface Property
Property value can be set in different ways :
org.sonar.api.resources.Project
(see method getConfiguration()
).
Must be used in org.sonar.api.Plugin
classes only.
PropertyDefinition
since v3.6.
Required Element Summary | |
---|---|
String |
key
Unique key within all plugins. |
String |
name
|
Optional Element Summary | |
---|---|
String |
category
|
String |
defaultValue
The empty string "" is considered as null, so it's not possible to have empty strings for default values. |
String |
deprecatedKey
Relocation of key. |
String |
description
|
PropertyField[] |
fields
A Property with fields is considered a property set. |
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 |
multiValues
Can the property take multiple values. |
String[] |
options
Options for *_LIST types |
boolean |
project
Is the property displayed in project settings page ? |
String |
propertySetKey
A Property of type PropertyType.PROPERTY_SET can reference a set of properties
by its key. |
PropertyType |
type
|
Element Detail |
---|
public abstract String key
public abstract String name
public abstract String defaultValue
public abstract String description
public abstract String category
PropertyDefinition.category()
public abstract boolean project
public abstract boolean module
public abstract boolean global
public abstract PropertyType type
public abstract String[] options
key:REGEXP
, domain:REGEXP
and type:comma_separated__list_of_types
.
For example key:new_.*
will match any metric which key starts by new_
.
For example type:INT,FLOAT
will match any metric of type INT
or FLOAT
.
For example type:NUMERIC
will match any metric of numerictype.public abstract boolean multiValues
public abstract String propertySetKey
PropertyType.PROPERTY_SET
can reference a set of properties
by its key.
public abstract PropertyField[] fields
public abstract String deprecatedKey
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |