Package com.e1c.g5.v8.dt.internal.check.settings

Class JSONCheckSettingsProfileStore

java.lang.Object

com.e1c.g5.v8.dt.internal.check.settings.JSONCheckSettingsProfileStore

All Implemented Interfaces:

IProjectCheckSettingsProfileStore

public class JSONCheckSettingsProfileStore
extends Object
implements IProjectCheckSettingsProfileStore

JSON format profile store

Constructor Summary

Constructors

Constructor	Description
JSONCheckSettingsProfileStore(org.eclipse.core.resources.IProject project, ICheckRepository checkRepository)	Constructs an instance of the store

Method Summary

Modifier and Type	Method	Description
void	deleteProfile(String profileName)	Deletes the given profile from the store.
void	duplicateProfile(String sourceProfileName, String destinationProfileName)	Duplicates given profile and names it accordingly
void	exportSettingsProfile(String profileName, Path destinationPath)	Exports an existing settings profile into the selected destination file The operation quietly replaces the existing file in the destination folder if any.
String	getActiveProfileName()	Gets the name of the active profile.
List<String>	getExistingProfileNames()	Gets the names of existing profiles
void	importSettingsProfile(Path sourcePath)	Imports an external settings profile into the project's set of profiles.
boolean	isMassiveCheckProcessDisabled()	Checks if the massive automatic check pre-computation process is disabled
Map<CheckUid,ProfileCheckSettingsData>	load(String profileName)	Loads the data from the store (if exists)
void	renameProfile(String currentProfileName, String newProfileName)	Renames the settings profile using the provided name.
void	save(Map<CheckUid,ProfileCheckSettingsData> settingsData, String profileName)	Saves the given data to the given profile
void	setActiveProfile(String newProfileName, boolean isDefaultProfile)	Sets active profile and stores in the corresponding preferences
void	setMassiveCheckProcessDisabled(boolean massiveCheckProcessDisabled)	Sets/resets massive check mode

Methods inherited from class java.lang.Object

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

Constructor Details

JSONCheckSettingsProfileStore

public JSONCheckSettingsProfileStore(org.eclipse.core.resources.IProject project,
 ICheckRepository checkRepository)

Constructs an instance of the store

Parameters:

project - Project which contains stored files and preferences

Method Details

deleteProfile

public void deleteProfile(String profileName)

Description copied from interface: IProjectCheckSettingsProfileStore

Deletes the given profile from the store. Ignores non-existing profile names quietly

Specified by:

deleteProfile in interface IProjectCheckSettingsProfileStore

Parameters:

profileName - The name of the profile to delete. May not be null

duplicateProfile

public void duplicateProfile(String sourceProfileName,
 String destinationProfileName)

Description copied from interface: IProjectCheckSettingsProfileStore

Duplicates given profile and names it accordingly

Specified by:

duplicateProfile in interface IProjectCheckSettingsProfileStore

Parameters:

sourceProfileName - The source profile name. May not be null

destinationProfileName - The destination profile name. May not be null. Must be unqique among currently registered profiles

exportSettingsProfile

public void exportSettingsProfile(String profileName,
 Path destinationPath)

Description copied from interface: IProjectCheckSettingsProfileStore

Exports an existing settings profile into the selected destination file The operation quietly replaces the existing file in the destination folder if any.

Specified by:

exportSettingsProfile in interface IProjectCheckSettingsProfileStore

Parameters:

profileName - The name of the profile. May not be null

destinationPath - The destination path to write the profile into. It'a full file path, not a folder. May not be null

getActiveProfileName

public String getActiveProfileName()

Description copied from interface: IProjectCheckSettingsProfileStore

Gets the name of the active profile.

Specified by:

getActiveProfileName in interface IProjectCheckSettingsProfileStore

Returns:

The name of the active profile. May be null in case if the active profile still not set/data is cleared

getExistingProfileNames

public List<String> getExistingProfileNames()

Description copied from interface: IProjectCheckSettingsProfileStore

Gets the names of existing profiles

Specified by:

getExistingProfileNames in interface IProjectCheckSettingsProfileStore

Returns:

The list of existing profile names. Never null

importSettingsProfile

public void importSettingsProfile(Path sourcePath)

Description copied from interface: IProjectCheckSettingsProfileStore

Imports an external settings profile into the project's set of profiles. The operation quietly replaces the existing file if any.

Specified by:

importSettingsProfile in interface IProjectCheckSettingsProfileStore

Parameters:

sourcePath - The path to the profile. May not be null

load

public Map<CheckUid,ProfileCheckSettingsData> load(String profileName)

Description copied from interface: IProjectCheckSettingsProfileStore

Loads the data from the store (if exists)

Specified by:

load in interface IProjectCheckSettingsProfileStore

Parameters:

profileName - The name of the profile. May not be null

Returns:

The profile's data. Never null

renameProfile

public void renameProfile(String currentProfileName,
 String newProfileName)

Description copied from interface: IProjectCheckSettingsProfileStore

Renames the settings profile using the provided name.

Specified by:

renameProfile in interface IProjectCheckSettingsProfileStore

Parameters:

currentProfileName - Current name of the profile. May not be null

save

public void save(Map<CheckUid,ProfileCheckSettingsData> settingsData,
 String profileName)

Description copied from interface: IProjectCheckSettingsProfileStore

Saves the given data to the given profile

Specified by:

save in interface IProjectCheckSettingsProfileStore

Parameters:

settingsData - The data to save. May not be null

profileName - The name of the profile. May not be null

setActiveProfile

public void setActiveProfile(String newProfileName,
 boolean isDefaultProfile)

Description copied from interface: IProjectCheckSettingsProfileStore

Sets active profile and stores in the corresponding preferences

Specified by:

setActiveProfile in interface IProjectCheckSettingsProfileStore

Parameters:

newProfileName - The name of the profile. May not be null

isDefaultProfile - The default profile set, with preferences clearance

isMassiveCheckProcessDisabled

public boolean isMassiveCheckProcessDisabled()

Description copied from interface: IProjectCheckSettingsProfileStore

Checks if the massive automatic check pre-computation process is disabled

Specified by:

isMassiveCheckProcessDisabled in interface IProjectCheckSettingsProfileStore

Returns:

True if the process is disabled

setMassiveCheckProcessDisabled

public void setMassiveCheckProcessDisabled(boolean massiveCheckProcessDisabled)

Description copied from interface: IProjectCheckSettingsProfileStore

Sets/resets massive check mode

Specified by:

setMassiveCheckProcessDisabled in interface IProjectCheckSettingsProfileStore

Parameters:

massiveCheckProcessDisabled - The mode to set