Package org.variantsync.diffdetective

Record Class AnalysisRunner.Options

java.lang.Object

java.lang.Record

org.variantsync.diffdetective.AnalysisRunner.Options

Record Components:

repositoriesDirectory - The directory to which all git repositories will be cloned to. If this directory already contains the required git repositories, those copies will be used.

outputDirectory - The directory to which any output data of the analysis should be written to.

datasetsFile - Path to a markdown file containing a table of git repositories to analyze.

getParseOptionsForRepo - Determines which PatchDiffParseOptions to use per repository. Each repository is by default, already equipped with options. If you wish no changes, just return Repository.getParseOptions() here.

getFilterForRepo - Determines which filter to use for parsing diffs in given repository that is about to be analyzed. Each repository is by default, already equipped with a filter. If you wish no changes, just return Repository.getDiffFilter() here.

preloadReposBeforeAnalysis - Decides whether all repositories should be cloned once before the analysis. If a repository does not have a local clone in repositoriesDirectory it will be cloned before the analysis if preloadReposBeforeAnalysis is set to true. Otherwise it will be cloned right before it is about to be analysed.

pullRepositoriesBeforeAnalysis - Decides whether git pull should be run on each repository before analysis. Takes effect only if preloadReposBeforeAnalysis is true. Does nothing otherwise.

Enclosing class:

AnalysisRunner

public static record AnalysisRunner.Options(Path repositoriesDirectory, Path outputDirectory, Path datasetsFile, Function<Repository,PatchDiffParseOptions> getParseOptionsForRepo, Function<Repository,DiffFilter> getFilterForRepo, boolean preloadReposBeforeAnalysis, boolean pullRepositoriesBeforeAnalysis)
extends Record

Field Summary

Fields

Modifier and Type	Field	Description
private final Path	datasetsFile	The field for the datasetsFile record component.
private final Function<Repository,DiffFilter>	getFilterForRepo	The field for the getFilterForRepo record component.
private final Function<Repository,PatchDiffParseOptions>	getParseOptionsForRepo	The field for the getParseOptionsForRepo record component.
private final Path	outputDirectory	The field for the outputDirectory record component.
private final boolean	preloadReposBeforeAnalysis	The field for the preloadReposBeforeAnalysis record component.
private final boolean	pullRepositoriesBeforeAnalysis	The field for the pullRepositoriesBeforeAnalysis record component.
private final Path	repositoriesDirectory	The field for the repositoriesDirectory record component.

Constructor Summary

Constructors

Constructor	Description
Options(Path repositoriesDirectory, Path outputDirectory, Path datasetsFile)	Creates options with the given parameters and uses default values for all other parameters.
Options(Path repositoriesDirectory, Path outputDirectory, Path datasetsFile, Function<Repository,PatchDiffParseOptions> getParseOptionsForRepo, Function<Repository,DiffFilter> getFilterForRepo, boolean preloadReposBeforeAnalysis, boolean pullRepositoriesBeforeAnalysis)	Creates an instance of a Options record class.

Method Summary

Modifier and Type	Method	Description
Path	datasetsFile()	Returns the value of the datasetsFile record component.
static AnalysisRunner.Options	DEFAULT(String[] args)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Function<Repository,DiffFilter>	getFilterForRepo()	Returns the value of the getFilterForRepo record component.
Function<Repository,PatchDiffParseOptions>	getParseOptionsForRepo()	Returns the value of the getParseOptionsForRepo record component.
final int	hashCode()	Returns a hash code value for this object.
Path	outputDirectory()	Returns the value of the outputDirectory record component.
boolean	preloadReposBeforeAnalysis()	Returns the value of the preloadReposBeforeAnalysis record component.
boolean	pullRepositoriesBeforeAnalysis()	Returns the value of the pullRepositoriesBeforeAnalysis record component.
Path	repositoriesDirectory()	Returns the value of the repositoriesDirectory record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

repositoriesDirectory

private final Path repositoriesDirectory

The field for the repositoriesDirectory record component.

outputDirectory

private final Path outputDirectory

The field for the outputDirectory record component.

datasetsFile

private final Path datasetsFile

The field for the datasetsFile record component.

getParseOptionsForRepo

private final Function<Repository,PatchDiffParseOptions> getParseOptionsForRepo

The field for the getParseOptionsForRepo record component.

getFilterForRepo

private final Function<Repository,DiffFilter> getFilterForRepo

The field for the getFilterForRepo record component.

preloadReposBeforeAnalysis

private final boolean preloadReposBeforeAnalysis

The field for the preloadReposBeforeAnalysis record component.

pullRepositoriesBeforeAnalysis

private final boolean pullRepositoriesBeforeAnalysis

The field for the pullRepositoriesBeforeAnalysis record component.

Constructor Details

Options

public Options(Path repositoriesDirectory,
 Path outputDirectory,
 Path datasetsFile)

Creates options with the given parameters and uses default values for all other parameters.

See Also:

• Options(Path, Path, Path, Function, Function, boolean, boolean)
• DEFAULT(String[])

Options

public Options(Path repositoriesDirectory,
 Path outputDirectory,
 Path datasetsFile,
 Function<Repository,PatchDiffParseOptions> getParseOptionsForRepo,
 Function<Repository,DiffFilter> getFilterForRepo,
 boolean preloadReposBeforeAnalysis,
 boolean pullRepositoriesBeforeAnalysis)

Creates an instance of a Options record class.

Parameters:

repositoriesDirectory - the value for the repositoriesDirectory record component

outputDirectory - the value for the outputDirectory record component

datasetsFile - the value for the datasetsFile record component

getParseOptionsForRepo - the value for the getParseOptionsForRepo record component

getFilterForRepo - the value for the getFilterForRepo record component

preloadReposBeforeAnalysis - the value for the preloadReposBeforeAnalysis record component

pullRepositoriesBeforeAnalysis - the value for the pullRepositoriesBeforeAnalysis record component

Method Details

DEFAULT

public static AnalysisRunner.Options DEFAULT(String[] args)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

repositoriesDirectory

public Path repositoriesDirectory()

Returns the value of the repositoriesDirectory record component.

Returns:

the value of the repositoriesDirectory record component

outputDirectory

public Path outputDirectory()

Returns the value of the outputDirectory record component.

Returns:

the value of the outputDirectory record component

datasetsFile

public Path datasetsFile()

Returns the value of the datasetsFile record component.

Returns:

the value of the datasetsFile record component

getParseOptionsForRepo

public Function<Repository,PatchDiffParseOptions> getParseOptionsForRepo()

Returns the value of the getParseOptionsForRepo record component.

Returns:

the value of the getParseOptionsForRepo record component

getFilterForRepo

public Function<Repository,DiffFilter> getFilterForRepo()

Returns the value of the getFilterForRepo record component.

Returns:

the value of the getFilterForRepo record component

preloadReposBeforeAnalysis

public boolean preloadReposBeforeAnalysis()

Returns the value of the preloadReposBeforeAnalysis record component.

Returns:

the value of the preloadReposBeforeAnalysis record component

pullRepositoriesBeforeAnalysis

public boolean pullRepositoriesBeforeAnalysis()

Returns the value of the pullRepositoriesBeforeAnalysis record component.

Returns:

the value of the pullRepositoriesBeforeAnalysis record component