Skip to content

Create Pref Service #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hinerm merged 16 commits into from
Jul 25, 2014
Merged

Create Pref Service #102

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9f210a7
Refactor Prefs to PrefService
hinerm Jul 18, 2014
4ef6f00
Update Prefs usage to PrefService
hinerm Jul 21, 2014
992f0b8
ModuleService: add save/load item methods
hinerm Jul 21, 2014
cc97d1b
Mark saveValue and loadValue deprecated
hinerm Jul 21, 2014
d503e31
Refactor for ModuleService saving and loading
hinerm Jul 21, 2014
ce0f105
AbstractPrefService: account for priority
hinerm Jul 21, 2014
9050328
Clean up code
hinerm Jul 21, 2014
6fe0553
DefaultPrefService: add TODO
hinerm Jul 21, 2014
f857d0f
Deprecate Prefs
hinerm Jul 21, 2014
a9a109c
PrefService: remove setStaticBehavior method
hinerm Jul 24, 2014
9abe3d9
PrefService: remove Preferences imports
hinerm Jul 24, 2014
7ff590f
Rename preferences to prefs package
hinerm Jul 25, 2014
344d6bc
DefaultPrefService: fix javadoc
ctrueden Jul 25, 2014
963d4eb
DefaultPrefService: do not reference Prefs class
ctrueden Jul 25, 2014
cdeb735
Add down-the-middle unit tests for PrefService
ctrueden Jul 25, 2014
a0c6c95
AbstractPrefService: suppress warnings
hinerm Jul 25, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update Prefs usage to PrefService 
All Contextual classes that used the Prefs static utility class should
now be using PrefService.
  • Loading branch information
@hinerm
hinerm committed Jul 25, 2014
commit 4ef6f0066f521d3f3ea8c11147eadb425701ae41
13 changes: 8 additions & 5 deletions src/main/java/org/scijava/io/DefaultRecentFileService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@
import org.scijava.module.ModuleService;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;
import org.scijava.preferences.PrefService;
import org.scijava.service.AbstractService;
import org.scijava.service.Service;
import org.scijava.util.FileUtils;
import org.scijava.util.Prefs;

// TODO - DefaultRecentFileService, DefaultWindowService, and DefaultLUTService
// all build menus dynamically (see createInfo()). We may be able to abstract a
Expand Down Expand Up @@ -98,6 +98,9 @@ public final class DefaultRecentFileService extends AbstractService implements
@Parameter
private CommandService commandService;

@Parameter
private PrefService prefService;

private List<String> recentFiles;
private Map<String, ModuleInfo> recentModules;

Expand All @@ -112,7 +115,7 @@ public void add(final String path) {
recentFiles.add(path);

// persist the updated list
Prefs.putList(recentFiles, RECENT_FILES_KEY);
prefService.putList(recentFiles, RECENT_FILES_KEY);

if (present) {
// path already present; update linked module info
Expand All @@ -136,7 +139,7 @@ public boolean remove(final String path) {
final boolean success = recentFiles.remove(path);

// persist the updated list
Prefs.putList(recentFiles, RECENT_FILES_KEY);
prefService.putList(recentFiles, RECENT_FILES_KEY);

// remove linked module info
final ModuleInfo info = recentModules.remove(path);
Expand All @@ -148,7 +151,7 @@ public boolean remove(final String path) {
@Override
public void clear() {
recentFiles.clear();
Prefs.clear(RECENT_FILES_KEY);
prefService.clear(RECENT_FILES_KEY);

// unregister the modules with the module service
moduleService.removeModules(recentModules.values());
Expand All @@ -165,7 +168,7 @@ public List<String> getRecentFiles() {

@Override
public void initialize() {
recentFiles = Prefs.getList(RECENT_FILES_KEY);
recentFiles = prefService.getList(RECENT_FILES_KEY);
recentModules = new HashMap<String, ModuleInfo>();
for (final String path : recentFiles) {
recentModules.put(path, createInfo(path));
Expand Down
7 changes: 5 additions & 2 deletions src/main/java/org/scijava/options/OptionsPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
import org.scijava.options.event.OptionsEvent;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.SingletonPlugin;
import org.scijava.util.Prefs;
import org.scijava.preferences.PrefService;

// TODO - outline for how to address issues with options (initializing, aggregating into 1 dialog)

Expand Down Expand Up @@ -77,6 +77,9 @@ public class OptionsPlugin extends DynamicCommand implements SingletonPlugin {
@Parameter
protected EventService eventService;

@Parameter
private PrefService prefService;

// -- OptionsPlugin methods --

/** Loads option values from persistent storage. */
Expand All @@ -95,7 +98,7 @@ public void save() {

/** Clears option values from persistent storage. */
public void reset() {
Prefs.clear(getClass());
prefService.clear(getClass());
}

// -- Runnable methods --
Expand Down
13 changes: 8 additions & 5 deletions src/main/java/org/scijava/ui/AbstractUserInterface.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@
import org.scijava.plugin.Parameter;
import org.scijava.plugin.PluginInfo;
import org.scijava.plugin.PluginService;
import org.scijava.preferences.PrefService;
import org.scijava.thread.ThreadService;
import org.scijava.ui.viewer.DisplayViewer;
import org.scijava.ui.viewer.DisplayWindow;
import org.scijava.util.Prefs;

/**
* Abstract superclass for {@link UserInterface} implementations.
Expand Down Expand Up @@ -80,6 +80,9 @@ public abstract class AbstractUserInterface extends AbstractRichPlugin
@Parameter
private UIService uiService;

@Parameter
private PrefService prefService;

/** Whether the UI is currently being displayed. */
private boolean visible = false;

Expand Down Expand Up @@ -181,17 +184,17 @@ public StatusBar getStatusBar() {
public void saveLocation() {
final ApplicationFrame appFrame = getApplicationFrame();
if (appFrame != null) {
Prefs.put(getClass(), LAST_X, appFrame.getLocationX());
Prefs.put(getClass(), LAST_Y, appFrame.getLocationY());
prefService.put(getClass(), LAST_X, appFrame.getLocationX());
prefService.put(getClass(), LAST_Y, appFrame.getLocationY());
}
}

@Override
public void restoreLocation() {
final ApplicationFrame appFrame = getApplicationFrame();
if (appFrame != null) {
final int lastX = Prefs.getInt(getClass(), LAST_X, 0);
final int lastY = Prefs.getInt(getClass(), LAST_Y, 0);
final int lastX = prefService.getInt(getClass(), LAST_X, 0);
final int lastY = prefService.getInt(getClass(), LAST_Y, 0);
appFrame.setLocation(lastX, lastY);
}
}
Expand Down
13 changes: 8 additions & 5 deletions src/main/java/org/scijava/welcome/DefaultWelcomeService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@
import org.scijava.log.LogService;
import org.scijava.plugin.Parameter;
import org.scijava.plugin.Plugin;
import org.scijava.preferences.PrefService;
import org.scijava.service.AbstractService;
import org.scijava.service.Service;
import org.scijava.text.TextService;
import org.scijava.ui.event.UIShownEvent;
import org.scijava.util.DigestUtils;
import org.scijava.util.Prefs;
import org.scijava.welcome.event.WelcomeEvent;

/**
Expand Down Expand Up @@ -82,6 +82,9 @@ public class DefaultWelcomeService extends AbstractService implements
@Parameter
private EventService eventService;

@Parameter
private PrefService prefService;

// -- ReadmeService methods --

@Override
Expand All @@ -96,9 +99,9 @@ private void displayWelcome(final boolean force) {
if (welcomeFile.exists()) {
final String welcomeText = textService.asHTML(welcomeFile);
final String checksum = DigestUtils.bestHex(welcomeText);
final String previousChecksum = Prefs.get(getClass(), CHECKSUM_PREFS_KEY);
final String previousChecksum = prefService.get(getClass(), CHECKSUM_PREFS_KEY);
if (!force && checksum.equals(previousChecksum)) return;
Prefs.put(getClass(), CHECKSUM_PREFS_KEY, checksum);
prefService.put(getClass(), CHECKSUM_PREFS_KEY, checksum);
displayService.createDisplay(welcomeText);
}
}
Expand All @@ -109,13 +112,13 @@ private void displayWelcome(final boolean force) {

@Override
public boolean isFirstRun() {
final String firstRun = Prefs.get(getClass(), firstRunPrefKey());
final String firstRun = prefService.get(getClass(), firstRunPrefKey());
return firstRun == null || Boolean.parseBoolean(firstRun);
}

@Override
public void setFirstRun(final boolean firstRun) {
Prefs.put(getClass(), firstRunPrefKey(), firstRun);
prefService.put(getClass(), firstRunPrefKey(), firstRun);
}

// -- Event handlers --
Expand Down