KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > edu > rice > cs > drjava > config > Configuration


1 /*BEGIN_COPYRIGHT_BLOCK
2  *
3  * This file is part of DrJava. Download the current version of this project from http://www.drjava.org/
4  * or http://sourceforge.net/projects/drjava/
5  *
6  * DrJava Open Source License
7  *
8  * Copyright (C) 2001-2005 JavaPLT group at Rice University (javaplt@rice.edu). All rights reserved.
9  *
10  * Developed by: Java Programming Languages Team, Rice University, http://www.cs.rice.edu/~javaplt/
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
13  * documentation files (the "Software"), to deal with the Software without restriction, including without limitation
14  * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
15  * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
16  *
17  * - Redistributions of source code must retain the above copyright notice, this list of conditions and the
18  * following disclaimers.
19  * - Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
20  * following disclaimers in the documentation and/or other materials provided with the distribution.
21  * - Neither the names of DrJava, the JavaPLT, Rice University, nor the names of its contributors may be used to
22  * endorse or promote products derived from this Software without specific prior written permission.
23  * - Products derived from this software may not be called "DrJava" nor use the term "DrJava" as part of their
24  * names without prior written permission from the JavaPLT group. For permission, write to javaplt@rice.edu.
25  *
26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
27  * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28  * CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
29  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
30  * WITH THE SOFTWARE.
31  *
32  *END_COPYRIGHT_BLOCK*/
33
34 package edu.rice.cs.drjava.config;
35
36 import edu.rice.cs.util.swing.Utilities;
37
38 /** Class to store and retrieve all configurable options.
39  * @version $Id: Configuration.java 4031 2006-11-15 22:09:06Z rcartwright $
40  */
41 public class Configuration {
42   
43   /** OptionMap used to store all option settings. */
44   protected OptionMap map;
45   
46   /** Any exception that is caught when initializing this Configuration object.
47    * Used later by the UI to display a useful message to the user.
48    */
49   protected Exception JavaDoc _startupException;
50   
51   /** Initializes this Configuration object with the given OptionMap.
52    * @param om An empty OptionMap.
53    */
54   public Configuration(OptionMap om) {
55     map = om;
56     _startupException = null;
57   }
58   
59   /** Sets the given option to the given value and notifies all listeners of that option of the change.
60    * @param op Option to set
61    * @param value New value for the option
62    */
63   public <T> T setSetting(final Option<T> op, final T value) {
64     T ret = map.setOption(op, value);
65     Utilities.invokeLater(new Runnable JavaDoc() { public void run() { op.notifyListeners(Configuration.this, value); } });
66     return ret;
67   }
68   
69   /** Gets the current value of the given Option. */
70   public <T> T getSetting(Option<T> op) { return map.getOption(op); }
71   
72   /** Adds an OptionListener to the given Option, to be notified each time the option changes.
73    * @param op Option to listen for changes on
74    * @param l OptionListener wishing to listen
75    */
76   public <T> void addOptionListener(Option<T> op, OptionListener<T> l) { op.addListener(this,l); }
77   
78   /** Removes an OptionListener from an Option to which it was listening. */
79   public <T> void removeOptionListener(Option<T> op, OptionListener<T> l) { op.removeListener(this,l); }
80   
81   /** Resets to the default values, overwriting any existing values. */
82   public void resetToDefaults() { OptionMapLoader.DEFAULT.loadInto(map); }
83   
84   /** Returns whether there were any exceptions when starting. */
85   public boolean hadStartupException() { return _startupException != null; }
86   
87   /** Returns the exception caught during startUp, or null if none were caught. */
88   public Exception JavaDoc getStartupException() { return _startupException; }
89   
90   /** Stores exception caught during creation of this Configuration object, so it can be displayed later by the UI.
91    * @param e Exception caught during startUp
92    */
93   public void storeStartupException(Exception JavaDoc e) { _startupException = e; }
94   
95   /** Returns a string representation of the contents of the OptionMap. */
96   public String JavaDoc toString() { return map.toString(); }
97 }
98
Popular Tags