org.sonar.api
Annotation Type PropertyField


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

Property field.

Since:
3.3

Required Element Summary
 String key
          Unique key within a property.
 String name
          This name will be displayed on the Settings page.
 
Optional Element Summary
 String description
          If not empty, this description will be displayed on the Settings page.
 int indicativeSize
          Indicative size of the field value in characters.
 String[] options
          Options for *_LIST types
 PropertyType type
           
 

Element Detail

key

public abstract String key
Unique key within a property. It shouldn't be prefixed. Settings for this field are stored into the database with a composite key {key of parent property}.{key of the set}.{key of this field} eg. sonar.jira.servers.JIRA1.url


name

public abstract String name
This name will be displayed on the Settings page. This can be overridden/translated by adding a a value for: field.{key of parent property}.{key of this field}.name in the language bundle.

description

public abstract String description
If not empty, this description will be displayed on the Settings page. This can be overridden/translated by adding a a value for: field.{key of parent property}.{key of this field}.description in the language bundle.

Default:
""

indicativeSize

public abstract int indicativeSize
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.

Default:
20

type

public abstract PropertyType type
Default:
org.sonar.api.PropertyType.STRING

options

public abstract String[] options
Options for *_LIST types

Default:
{}


Copyright © 2009–2014 SonarSource. All rights reserved.