org.sonar.check

Annotation Type Rule

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

Since:

2.3

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Cardinality	cardinality
String	description The description, optional.
IsoCategory	isoCategory Deprecated. since 2.5. See http://jira.codehaus.org/browse/SONAR-2007
String	key The default key is the class name.
String	name The rule name.
Priority	priority Default priority.

Element Detail

key

public abstract String key

The default key is the class name.

Default:

""

name

public abstract String name

The rule name. If not defined, then the name is the key

Default:

""

description

public abstract String description

The description, optional.

Default:

""

priority

public abstract Priority priority

Default priority.

Default:

org.sonar.check.Priority.MAJOR

isoCategory

@Deprecated
public abstract IsoCategory isoCategory

Deprecated. since 2.5. See http://jira.codehaus.org/browse/SONAR-2007

Will probably be deprecated and replaced by tags

Default:

org.sonar.check.IsoCategory.NONE

cardinality

public abstract Cardinality cardinality

Default:

org.sonar.check.Cardinality.SINGLE