Package cdc.issues.rules

Interface IssuesDetector<T>

Type Parameters:

T - The data type onto which issue can be detected.

All Known Implementing Classes:

AbstractIssueDetector

public interface IssuesDetector<T>

Interface implemented by classes that can detect issues.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IssuesDetector.AbstractDescriptor<T>
static interface	IssuesDetector.Descriptor<T>	Interface implemented by classes that can describe and create an IssuesDetector.

Method Summary

Modifier and Type	Method	Description
default void	analyze(T data, Location location, IssuesHandler<Issue> issuesHandler)	Analyzes one data.
void	analyze(T data, List<Location> locations, IssuesHandler<Issue> issuesHandler)	Analyzes one data.
default Class<T>	getDataClass()
IssuesDetector.Descriptor<T>	getDescriptor()
Set<ConfiguredRule>	getEnabledConfiguredRules()
Set<Rule>	getEnabledRules()
String	getProject()
String	getSnapshot()
static String	toString(IssuesDetector<?> detector)

Method Detail

getDescriptor

IssuesDetector.Descriptor<T> getDescriptor()

Returns:

The descriptor that was used to create this IssuesDetector.

getDataClass

default Class<T> getDataClass()

Returns:

The class of data that can be analyzed.

getProject

String getProject()

Returns:

The project name of analyzed data.

getSnapshot

String getSnapshot()

Returns:

The snapshot name for which analysis is done.

getEnabledRules

Set<Rule> getEnabledRules()

Returns:

The set of enabled rules.

getEnabledConfiguredRules

Set<ConfiguredRule> getEnabledConfiguredRules()

Returns:

The set of enabled ConfiguredRules.

analyze

void analyze(T data,
             List<Location> locations,
             IssuesHandler<Issue> issuesHandler)

Analyzes one data.

Parameters:

data - The data to analyze.

locations - The data locations. Must NOT be empty.

issuesHandler - The issues handler that must be used to store issues.

analyze

default void analyze(T data,
                     Location location,
                     IssuesHandler<Issue> issuesHandler)

Analyzes one data.

Parameters:

data - The data to analyze.

location - The data location.

issuesHandler - The issues handler that must be used to store issues.

toString

static String toString(IssuesDetector<?> detector)