org.sonar.api.batch.rule

Interface Rules

@ScannerSide
public interface Rules

Searches for rules. This component is available by dependency injection. It must not be extended by plugins.

Since:

4.2

Method Summary

Modifier and Type	Method and Description
Rule	find(RuleKey key) Get a rule by its key.
Collection<Rule>	findAll()
Collection<Rule>	findByInternalKey(String repository, String internalKey)
Collection<Rule>	findByRepository(String repository) Get the rules of the given repository.

Method Detail

find

@CheckForNull
Rule find(RuleKey key)

Get a rule by its key. Returns null if rule does not exist.

findAll

Collection<Rule> findAll()

findByRepository

Collection<Rule> findByRepository(String repository)

Get the rules of the given repository. Returns an empty collection if the repository does not exist.

findByInternalKey

Collection<Rule> findByInternalKey(String repository,
                                   String internalKey)

Since:

5.2