com.intel.gpe.client2.defaults
Class Defaults

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<java.lang.Object,java.lang.Object>
          java.util.Properties
              com.intel.gpe.client2.defaults.Defaults

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public abstract class Defaults
extends java.util.Properties

Define, load and save user default values

Version:

$Id: Defaults.java,v 1.2 2006/10/20 08:51:58 dizhigul Exp $

Author:

Ralf Ratering

See Also:

Serialized Form

Field Summary

protected java.lang.String	configDir
protected java.lang.String	userHome
protected java.lang.String	userName

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Defaults(java.util.Properties userDefaults)

Defaults(java.lang.String configDirName)
Constructor looks for user defaults file.

Method Summary

protected boolean	booleanValue(java.lang.String prop) Helper function: Parse a String for a Boolean and return 0 if String contains no Boolean
protected java.lang.String	colorString(java.awt.Color color)
protected javax.swing.plaf.ColorUIResource	colorValue(java.lang.String prop) Parse a comma delimited list of 3 strings into a Color
protected int	defaultIntValue(java.lang.String prop)
protected long	defaultLongValue(java.lang.String prop)
protected double	doubleValue(java.lang.String prop) Parse a String for a Double and return 0 if String contains no Double
protected abstract void	genSystemDefaults() Fill properties with default values
java.lang.String	getConfigDir() Get path to config directory
java.lang.String	getProperty(java.lang.String prop) Overwrite getProperty method to prevent return value null and return "" instead.
java.lang.String	getProperty(java.lang.String prop, java.lang.String defaultValue)
java.lang.String	getUserHome() Gets the userHome
java.lang.String	getUserName() Gets the userName
protected int	intValue(java.lang.String prop) Helper function: Parse a String for an Integer and return 0 if String contains no integer
void	load(java.util.Properties userDefaults)
abstract boolean	loadFromFile()
protected boolean	loadFromFile(java.lang.String filename) Load user default values from file
protected long	longValue(java.lang.String prop) Helper function: Parse a String for an Long and return 0 if String contains no integer
protected void	update() Overwrite this method to update system with new default entries
abstract void	writeToFile() Try to write user default values to file
protected void	writeToFile(java.lang.String filename)

Methods inherited from class java.util.Properties

list, list, load, loadFromXML, propertyNames, save, setProperty, store, storeToXML, storeToXML

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

userHome

protected java.lang.String userHome

userName

protected java.lang.String userName

configDir

protected java.lang.String configDir

Constructor Detail

Defaults

public Defaults(java.util.Properties userDefaults)

Defaults

public Defaults(java.lang.String configDirName)
         throws java.lang.Exception

Constructor looks for user defaults file. If no such file exists user defaults are generated from scratch and a new defaults file will be generated

Throws:

java.lang.Exception

Method Detail

booleanValue

protected boolean booleanValue(java.lang.String prop)
                        throws java.lang.Exception

Helper function: Parse a String for a Boolean and return 0 if String contains no Boolean

Throws:

java.lang.Exception

colorString

protected java.lang.String colorString(java.awt.Color color)

colorValue

protected javax.swing.plaf.ColorUIResource colorValue(java.lang.String prop)
                                               throws java.lang.Exception

Parse a comma delimited list of 3 strings into a Color

Throws:

java.lang.Exception

defaultIntValue

protected int defaultIntValue(java.lang.String prop)

defaultLongValue

protected long defaultLongValue(java.lang.String prop)

doubleValue

protected double doubleValue(java.lang.String prop)
                      throws java.lang.Exception

Parse a String for a Double and return 0 if String contains no Double

Throws:

java.lang.Exception

genSystemDefaults

protected abstract void genSystemDefaults()

Fill properties with default values

getProperty

public java.lang.String getProperty(java.lang.String prop)

Overwrite getProperty method to prevent return value null and return "" instead. This is important to prevent null pointer execptions from faulty UserDefaults files.

Overrides:

getProperty in class java.util.Properties

Parameters:

prop - property value

Returns:

"" if property not available

getProperty

public java.lang.String getProperty(java.lang.String prop,
                                    java.lang.String defaultValue)

Overrides:

getProperty in class java.util.Properties

getConfigDir

public java.lang.String getConfigDir()

Get path to config directory

getUserHome

public java.lang.String getUserHome()

Gets the userHome

getUserName

public java.lang.String getUserName()

Gets the userName

intValue

protected int intValue(java.lang.String prop)

Helper function: Parse a String for an Integer and return 0 if String contains no integer

loadFromFile

public abstract boolean loadFromFile()

loadFromFile

protected boolean loadFromFile(java.lang.String filename)

Load user default values from file

Returns:

true if loading was successful, else false

longValue

protected long longValue(java.lang.String prop)

Helper function: Parse a String for an Long and return 0 if String contains no integer

update

protected void update()

Overwrite this method to update system with new default entries

writeToFile

public abstract void writeToFile()
                          throws java.lang.Exception

Try to write user default values to file

Throws:

java.lang.Exception

writeToFile

protected void writeToFile(java.lang.String filename)
                    throws java.lang.Exception

Throws:

java.lang.Exception

load

public void load(java.util.Properties userDefaults)