Package eu.solven.cleanthat.language.java.eclipse.generator

Class EclipseStylesheetGenerator

java.lang.Object

eu.solven.cleanthat.language.java.eclipse.generator.EclipseStylesheetGenerator

All Implemented Interfaces:

IEclipseStylesheetGenerator

public class EclipseStylesheetGenerator
extends Object
implements IEclipseStylesheetGenerator

Default implementation for IEclipseStylesheetGenerator

Author:

Benoit Lacelle

Constructor Summary

Constructors

Constructor	Description
EclipseStylesheetGenerator()

Method Summary

Modifier and Type	Method	Description
protected ScoredOption<Map<String,String>>	computeScore(Collection<String> contents, Map<String,String> tweakedConfiguration)
protected ScoredOption<Map<String,String>>	findBestDefaultSetting(OffsetDateTime max, Map<Path,String> pathToFile)
Map<String,String>	generateSettings(OffsetDateTime timeout, Map<Path,String> pathToFile)	This method is useful to generate automatically an Eclipse configuration which match an existing code-base.
protected Set<String>	getAllSetttings()
CodeDiffHelper	getCodeDiffHelper()
protected Set<String>	getMostImpactfulSettings()
protected Map<String,Map<String,String>>	loadDefaultConfigurations()
Map<Path,String>	loadFilesContent(Path rootForFiles, Pattern fileMatcher)
void	logBestDefaultConfig(Map<String,Map<String,String>> keyToConfig, ScoredOption<Map<String,String>> bestDefaultConfig)
protected void	logPathsImpactedByConfiguration(Map<Path,String> pathToFile, ScoredOption<Map<String,String>> bestOption)
protected ScoredOption<Map<String,String>>	optimizeSetOfSettings(OffsetDateTime timeout, Map<Path,String> pathToFile, ScoredOption<Map<String,String>> bestSettings, Set<String> settingsToSwitch)
ScoredOption<Map<String,String>>	pickOptimalOption(Collection<String> contents, ScoredOption<Map<String,String>> initialOptions, String parameterToSwitch)
protected void	prepareConfig(Map<String,Map<String,String>> keyToConfig)
ScoredOption<Map<String,String>>	searchForOptimalConfiguration(OffsetDateTime timeout, Map<Path,String> pathToFile, ScoredOption<Map<String,String>> bestDefaultConfig)

Methods inherited from class java.lang.Object

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

Constructor Detail

EclipseStylesheetGenerator

public EclipseStylesheetGenerator()

Method Detail

getMostImpactfulSettings

protected Set<String> getMostImpactfulSettings()

generateSettings

public Map<String,String> generateSettings(OffsetDateTime timeout,
                                                 Map<Path,String> pathToFile)

This method is useful to generate automatically an Eclipse configuration which match an existing code-base. It is especially useful for people NOT using Eclipse IDE.

Specified by:

generateSettings in interface IEclipseStylesheetGenerator

Parameters:

pathToFile - a Map of Path to the content of the File.

timeout - the maximum duration of the operation

Returns:

the Set of options which minimizes the modifications over input contents.

searchForOptimalConfiguration

public ScoredOption<Map<String,String>> searchForOptimalConfiguration(OffsetDateTime timeout,
                                                                            Map<Path,String> pathToFile,
                                                                            ScoredOption<Map<String,String>> bestDefaultConfig)

Parameters:

timeout - at this point of time, we'll interrupt the process

pathToFile -

bestDefaultConfig -

Returns:

getAllSetttings

protected Set<String> getAllSetttings()

optimizeSetOfSettings

protected ScoredOption<Map<String,String>> optimizeSetOfSettings(OffsetDateTime timeout,
                                                                       Map<Path,String> pathToFile,
                                                                       ScoredOption<Map<String,String>> bestSettings,
                                                                       Set<String> settingsToSwitch)

logPathsImpactedByConfiguration

protected void logPathsImpactedByConfiguration(Map<Path,String> pathToFile,
                                               ScoredOption<Map<String,String>> bestOption)

findBestDefaultSetting

protected ScoredOption<Map<String,String>> findBestDefaultSetting(OffsetDateTime max,
                                                                        Map<Path,String> pathToFile)

Parameters:

max -

pathToFile -

Returns:

the best configuration amongst a small set of standard configurations

loadDefaultConfigurations

protected Map<String,Map<String,String>> loadDefaultConfigurations()

prepareConfig

protected void prepareConfig(Map<String,Map<String,String>> keyToConfig)

logBestDefaultConfig

public void logBestDefaultConfig(Map<String,Map<String,String>> keyToConfig,
                                 ScoredOption<Map<String,String>> bestDefaultConfig)

pickOptimalOption

public ScoredOption<Map<String,String>> pickOptimalOption(Collection<String> contents,
                                                                ScoredOption<Map<String,String>> initialOptions,
                                                                String parameterToSwitch)

Parameters:

contents -

initialOptions -

parameterToSwitch -

Returns:

the best option, excluding the current setting.

computeScore

protected ScoredOption<Map<String,String>> computeScore(Collection<String> contents,
                                                              Map<String,String> tweakedConfiguration)

loadFilesContent

public Map<Path,String> loadFilesContent(Path rootForFiles,
                                               Pattern fileMatcher)
                                        throws IOException

Specified by:

loadFilesContent in interface IEclipseStylesheetGenerator

Throws:

IOException

getCodeDiffHelper

public CodeDiffHelper getCodeDiffHelper()