org.sonar.plugins.java.api

Interface CheckRegistrar

All Superinterfaces:

org.sonar.api.BatchComponent, org.sonar.api.BatchExtension, org.sonar.api.Extension

@Beta
public interface CheckRegistrar
extends org.sonar.api.BatchExtension

This batch extension should be extended to provide the classes to be used to instantiate checks. The register method has to be implemented and the registrarContext should register the repository keys.

   public void register(RegistrarContext registrarContext) {
     registrarContext.registerClassesForRepository("RepositoryKey", listOfCheckClasses);
   }
   
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CheckRegistrar.RegistrarContext

Method Summary

Methods

Modifier and Type	Method and Description
void	register(CheckRegistrar.RegistrarContext registrarContext) This method is called during an analysis to get the classes to use to instantiate checks.

Method Detail

register

void register(CheckRegistrar.RegistrarContext registrarContext)

This method is called during an analysis to get the classes to use to instantiate checks.

Parameters:

registrarContext - the context that will be used by the java-plugin to retrieve the classes for checks.