Package cdc.issues.rules

Interface IssuesDetector.Factory<T>

Type Parameters:

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

All Known Implementing Classes:

IssuesDetector.AbstractFactory

Enclosing interface:

IssuesDetector<T>

public static interface IssuesDetector.Factory<T>

Interface implemented by classes that can describe and create an IssuesDetector.

Author:

Damien Carbonne

Method Summary

Modifier and Type	Method	Description
default IssuesDetector<T>	create(String project, String snapshot, ConfiguredRule configuredRule)	Creates and configures an IssuesDetector to analyze some rules.
default IssuesDetector<T>	create(String project, String snapshot, ConfiguredRule... configuredRules)	Creates and configures an IssuesDetector to analyze some rules.
IssuesDetector<T>	create(String project, String snapshot, Set<ConfiguredRule> configuredRules)	Creates and configures an IssuesDetector to analyze some rules.
Class<T>	getDataClass()
Set<Rule>	getSupportedRules()

Method Detail

getDataClass

Class<T> getDataClass()

Returns:

The class of data that can be analyzed.

getSupportedRules

Set<Rule> getSupportedRules()

Returns:

The set of all supported Rules.

create

IssuesDetector<T> create(String project,
                         String snapshot,
                         Set<ConfiguredRule> configuredRules)

Creates and configures an IssuesDetector to analyze some rules.

Parameters:

project - The project for which detection is run.

snapshot - The snapshot for which detection is run.

configuredRules - The configured rules for which analysis must be performed.
Rules must be a subset of supported rules and associated params must comply with expected params.

Returns:

A newly created IssuesDetector, configured with configuredRules and rules.

create

default IssuesDetector<T> create(String project,
                                 String snapshot,
                                 ConfiguredRule... configuredRules)

Creates and configures an IssuesDetector to analyze some rules.

Parameters:

project - The project for which detection is run.

snapshot - The snapshot for which detection is run.

configuredRules - The configured rules for which analysis must be performed.
Rules must be a subset of supported rules and associated params must comply with expected params.

Returns:

A newly created IssuesDetector, configured with configuredRules and rules.

create

default IssuesDetector<T> create(String project,
                                 String snapshot,
                                 ConfiguredRule configuredRule)

Creates and configures an IssuesDetector to analyze some rules.

Parameters:

project - The project for which detection is run.

snapshot - The snapshot for which detection is run.

configuredRule - The configured rule for which analysis must be performed.
The rule must be one of supported rules and params must comply with Rule.getParams().

Returns:

A newly created IssuesDetector, configured with configuredRules.