annotate java/src/uk/ac/qmul/eecs/ccmi/utils/PreferencesService.java @ 1:e3935c01cde2 tip

moved license of PdPersistenceManager to the beginning of the file
author Fiore Martin <f.martin@qmul.ac.uk>
date Tue, 08 Jul 2014 19:52:03 +0100
parents 78b7fc5391a2
children
rev   line source
f@0 1 /*
f@0 2 CCmI Editor - A Collaborative Cross-Modal Diagram Editing Tool
f@0 3
f@0 4 Copyright (C) 2002 Cay S. Horstmann (http://horstmann.com)
f@0 5 Copyright (C) 2011 Queen Mary University of London (http://ccmi.eecs.qmul.ac.uk/)
f@0 6
f@0 7 This program is free software: you can redistribute it and/or modify
f@0 8 it under the terms of the GNU General Public License as published by
f@0 9 the Free Software Foundation, either version 3 of the License, or
f@0 10 (at your option) any later version.
f@0 11
f@0 12 This program is distributed in the hope that it will be useful,
f@0 13 but WITHOUT ANY WARRANTY; without even the implied warranty of
f@0 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f@0 15 GNU General Public License for more details.
f@0 16
f@0 17 You should have received a copy of the GNU General Public License
f@0 18 along with this program. If not, see <http://www.gnu.org/licenses/>.
f@0 19 */
f@0 20
f@0 21 package uk.ac.qmul.eecs.ccmi.utils;
f@0 22
f@0 23 import java.util.prefs.Preferences;
f@0 24
f@0 25 /**
f@0 26 * A service for storing and loading user preferences.
f@0 27 */
f@0 28 public abstract class PreferencesService
f@0 29 {
f@0 30 /**
f@0 31 * Gets an instance of the service, suitable for the package of the given class.
f@0 32 * @return an instance of the service
f@0 33 */
f@0 34 public static PreferencesService getInstance(){
f@0 35 if (service != null) return service;
f@0 36 try{
f@0 37 service = new DefaultPreferencesService();
f@0 38 return service;
f@0 39 }
f@0 40 catch (SecurityException exception){
f@0 41 throw new RuntimeException(exception);
f@0 42 }
f@0 43 }
f@0 44
f@0 45 /**
f@0 46 * Gets a previously stored string from the service.
f@0 47 * @param key the key of the string
f@0 48 * @param defval the value to return if no matching value was found
f@0 49 * @return the value stored with the given key, or defval if none was found
f@0 50 */
f@0 51 public abstract String get(String key, String defval);
f@0 52 /**
f@0 53 * Saves a key/value pair for later retrieval.
f@0 54 * @param key the key of the string to be stored
f@0 55 * @param value the value to to be stored
f@0 56 */
f@0 57 public abstract void put(String key, String value);
f@0 58
f@0 59 private static PreferencesService service;
f@0 60 }
f@0 61
f@0 62 /**
f@0 63 * The default preferences service that uses the java.util.prefs API.
f@0 64 */
f@0 65 class DefaultPreferencesService extends PreferencesService{
f@0 66
f@0 67 public DefaultPreferencesService(){
f@0 68 prefs = Preferences.userNodeForPackage(this.getClass());
f@0 69 }
f@0 70
f@0 71 @Override
f@0 72 public String get(String key, String defval) { return prefs.get(key, defval); }
f@0 73 @Override
f@0 74 public void put(String key, String defval) { prefs.put(key, defval); }
f@0 75
f@0 76 private Preferences prefs;
f@0 77 }