Package cdc.issues.checks

Class SnapshotManager

java.lang.Object

cdc.issues.checks.SnapshotManager

All Implemented Interfaces:

SnapshotData

public class SnapshotManager
extends Object
implements SnapshotData

Interface used to build a snapshot and associated data.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotManager.Builder<B extends SnapshotManager.Builder<B>>	Builder of SnapshotManager.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SnapshotManager(SnapshotManager.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
static SnapshotManager.Builder<?>	builder()
IssuesCollector<Issue>	getIssuesCollector()
String	getIssuesHash()
int	getNumberOfIssues()
Optional<Profile>	getProfile()
String	getProjectDescription()
Params	getProjectMetas()
String	getProjectName()
String	getSnapshotDescription()
Params	getSnapshotMetas()
String	getSnapshotName()
Instant	getSnapshotTimestamp()
CheckStats<Location>	getStats()
boolean	hasStats()
<O> void	register(String name, AbstractChecker<O> checker)	Registers a checker and associate to a name.
<O> Optional<AbstractChecker<O>>	resolve(Class<O> objectClass, String name)	Returns the checker that was registered with a name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SnapshotManager

protected SnapshotManager(SnapshotManager.Builder<?> builder)

Method Detail

getProjectName

public final String getProjectName()

Specified by:

getProjectName in interface SnapshotData

Returns:

The project name.

getProjectDescription

public final String getProjectDescription()

Specified by:

getProjectDescription in interface SnapshotData

Returns:

The project description.

getProjectMetas

public final Params getProjectMetas()

Specified by:

getProjectMetas in interface SnapshotData

Returns:

The project meta data.

getProfile

public final Optional<Profile> getProfile()

Specified by:

getProfile in interface SnapshotData

Returns:

The project profile.

getSnapshotName

public final String getSnapshotName()

Specified by:

getSnapshotName in interface SnapshotData

Returns:

The snapshot name.

getSnapshotDescription

public final String getSnapshotDescription()

Specified by:

getSnapshotDescription in interface SnapshotData

Returns:

The snapshot description.

getSnapshotMetas

public final Params getSnapshotMetas()

Specified by:

getSnapshotMetas in interface SnapshotData

Returns:

The snapshot meta data.

getSnapshotTimestamp

public final Instant getSnapshotTimestamp()

Specified by:

getSnapshotTimestamp in interface SnapshotData

Returns:

The snapshot timestamp.

getNumberOfIssues

public final int getNumberOfIssues()

Specified by:

getNumberOfIssues in interface SnapshotData

Returns:

The number of issues of the snapshot.

getIssuesHash

public final String getIssuesHash()

Specified by:

getIssuesHash in interface SnapshotData

Returns:

The issues hash.

getIssuesCollector

public final IssuesCollector<Issue> getIssuesCollector()

Returns:

The IssuesCollector used to collect detected issues.

getStats

public final CheckStats<Location> getStats()

Returns:

The object used to collect statistics.

hasStats

public final boolean hasStats()

register

public final <O> void register(String name,
                               AbstractChecker<O> checker)

Registers a checker and associate to a name.

Type Parameters:

O - The checked object type.

Parameters:

name - The name used to designate the registered checker.

checker - The checker.

resolve

public final <O> Optional<AbstractChecker<O>> resolve(Class<O> objectClass,
                                                      String name)

Returns the checker that was registered with a name.

Type Parameters:

O - The checked object type.

Parameters:

objectClass - The checked object class.

name - The name of the checker to retrieve.

Returns:

The corresponding checker.

builder

public static SnapshotManager.Builder<?> builder()