org.sonar.api.web

Annotation Type RequiredMeasures

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

Annotation used to specify which measures should be available on a snapshot to be able to display a view (page, tab, ...). It is possible to give a list of mandatory measures (= if one is not available, the view is not displayed) and/or a list of needed measures (only one of them needs to be available). The measures are specified using the metric keys.

Example: the DesignPage absolutely requires the "dsm" measure to be fed in order to be displayed, whatever the language. The class will define a @RequiredMeasures(allOf={"dsm"}) annotation.

Since:

3.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allOf Lists all the measures that must absolutely to be available on the snapshot in order to display the view.
String[]	anyOf Lists all needed measures required to display the view.

Element Detail

allOf

public abstract String[] allOf

Lists all the measures that must absolutely to be available on the snapshot in order to display the view.

Returns:

the list of mandatory measures, identified by their metric key

Default:

{}

anyOf

public abstract String[] anyOf

Lists all needed measures required to display the view. If only one of them is available on the snapshot, then the view is displayed.

Returns:

the list of needed measures, identified by their metric key

Default:

{}