KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > modeler > ModelerPreferences


1 /* ====================================================================
2  *
3  * The ObjectStyle Group Software License, version 1.1
4  * ObjectStyle Group - http://objectstyle.org/
5  *
6  * Copyright (c) 2002-2005, Andrei (Andrus) Adamchik and individual authors
7  * of the software. All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright
14  * notice, this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright
17  * notice, this list of conditions and the following disclaimer in
18  * the documentation and/or other materials provided with the
19  * distribution.
20  *
21  * 3. The end-user documentation included with the redistribution, if any,
22  * must include the following acknowlegement:
23  * "This product includes software developed by independent contributors
24  * and hosted on ObjectStyle Group web site (http://objectstyle.org/)."
25  * Alternately, this acknowlegement may appear in the software itself,
26  * if and wherever such third-party acknowlegements normally appear.
27  *
28  * 4. The names "ObjectStyle Group" and "Cayenne" must not be used to endorse
29  * or promote products derived from this software without prior written
30  * permission. For written permission, email
31  * "andrus at objectstyle dot org".
32  *
33  * 5. Products derived from this software may not be called "ObjectStyle"
34  * or "Cayenne", nor may "ObjectStyle" or "Cayenne" appear in their
35  * names without prior written permission.
36  *
37  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40  * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
41  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48  * SUCH DAMAGE.
49  * ====================================================================
50  *
51  * This software consists of voluntary contributions made by many
52  * individuals and hosted on ObjectStyle Group web site. For more
53  * information on the ObjectStyle Group, please see
54  * <http://objectstyle.org/>.
55  */
56 package org.objectstyle.cayenne.modeler;
57
58 import java.io.File JavaDoc;
59 import java.io.FileInputStream JavaDoc;
60 import java.io.FileOutputStream JavaDoc;
61 import java.io.IOException JavaDoc;
62
63 import org.apache.commons.collections.ExtendedProperties;
64 import org.apache.log4j.Logger;
65 import org.objectstyle.cayenne.project.CayenneUserDir;
66
67 /**
68  * ModelerPreferences class supports persistent user preferences. Preferences are saved in
69  * the user home directory in "<code>$HOME/.cayenne/modeler.preferences</code>" file.
70  * <p>
71  * <i>This class is obsolete; its users will be migrated to use preference service. </i>
72  * </p>
73  */
74 public class ModelerPreferences extends ExtendedProperties {
75
76     private static final Logger logObj = Logger.getLogger(ModelerPreferences.class);
77
78     /** Name of the preferences file. */
79     public static final String JavaDoc PREFERENCES_NAME = "modeler.preferences";
80
81     /** Name of the log file. */
82     public static final String JavaDoc LOGFILE_NAME = "modeler.log";
83
84     // Keys for the preference file.
85
86     /** List of the last 4 opened project files. */
87     public static final String JavaDoc LAST_PROJ_FILES = "Editor.lastSeveralProjectFiles";
88
89     /** GUI layout */
90     public static final String JavaDoc EDITOR_LAFNAME = "Editor.lookAndFeel";
91     public static final String JavaDoc EDITOR_THEMENAME = "Editor.theme";
92
93     /** Log file */
94     public static final String JavaDoc EDITOR_LOGFILE_ENABLED = "Editor.logfileEnabled";
95     public static final String JavaDoc EDITOR_LOGFILE = "Editor.logfile";
96
97     protected static ModelerPreferences sharedInstance;
98
99     protected ModelerPreferences() {
100     }
101
102     /**
103      * Returns Cayenne preferences singleton.
104      */
105     public static ModelerPreferences getPreferences() {
106         if (sharedInstance == null) {
107             sharedInstance = new ModelerPreferences();
108             sharedInstance.loadPreferences();
109         }
110
111         return sharedInstance;
112     }
113
114     /**
115      * Returns preferences directory <code>$HOME/.cayenne</code>. If such directory
116      * does not exist, it is created as a side effect of this method.
117      */
118     public File JavaDoc preferencesDirectory() {
119         return CayenneUserDir.getInstance().getDirectory();
120     }
121
122     /**
123      * Saves preferences. Preferences stored in
124      * <code>$HOME/.cayenne/modeler.preferences</code> file.
125      */
126     public void storePreferences() {
127         File JavaDoc prefFile = new File JavaDoc(preferencesDirectory(), PREFERENCES_NAME);
128         try {
129             if (!prefFile.exists()) {
130                 logObj.debug("Cannot save preferences - file "
131                         + prefFile
132                         + " does not exist");
133                 return;
134             }
135             save(new FileOutputStream JavaDoc(prefFile), "");
136         }
137         catch (IOException JavaDoc e) {
138             logObj.debug("Error saving preferences: ", e);
139         }
140     }
141
142     /**
143      * Loads preferences from <code>$HOME/.cayenne/modeler.preferences</code> file.
144      */
145     public void loadPreferences() {
146         try {
147             File JavaDoc prefsFile = new File JavaDoc(preferencesDirectory(), PREFERENCES_NAME);
148             if (!prefsFile.exists()) {
149                 if (!prefsFile.createNewFile()) {
150                     logObj.warn("Can't create preferences file " + prefsFile);
151                 }
152             }
153
154             load(new FileInputStream JavaDoc(prefsFile));
155         }
156         catch (IOException JavaDoc e) {
157             logObj.warn("Error creating preferences file.", e);
158         }
159     }
160
161 }
Popular Tags