Homepage

netx.jnlp.util
Class PropertiesFile

java.lang.Object
  extended by java.util.Dictionary
      extended by java.util.Hashtable
          extended by java.util.Properties
              extended by netx.jnlp.util.PropertiesFile
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map

public class PropertiesFile
extends java.util.Properties

A properties object backed by a specified file without throwing exceptions. The properties are automatically loaded from the file when the first property is requested, but the save method must be called before changes are saved to the file.

This class does not report IO exceptions.

Version:
$Revision: 1.4 $
Author:
Jon A. Maxwell (JAM) - initial author
See Also:
Serialized Form

Field Summary
(package private)  java.io.File file
          the file to save to
(package private)  java.lang.String header
          the header string
(package private)  boolean loaded
          lazy loaded on getProperty
 
Fields inherited from class java.util.Properties
defaults
 
Constructor Summary
PropertiesFile(java.io.File file)
          Create a properties object backed by the specified file.
PropertiesFile(java.io.File file, java.lang.String header)
          Create a properties object backed by the specified file.
 
Method Summary
 java.lang.String getProperty(java.lang.String key)
          Returns the value of the specified key, or null if the key does not exist.
 java.lang.String getProperty(java.lang.String key, java.lang.String defaultValue)
          Returns the value of the specified key, or the default value if the key does not exist.
 java.io.File getStoreFile()
          Returns the file backing this properties object.
 void load()
          Ensures that the file backing these properties has been loaded; call this method before calling any method defined by a superclass.
 java.lang.Object setProperty(java.lang.String key, java.lang.String value)
          Sets the value for the specified key.
 void store()
          Saves the properties to the file.
 
Methods inherited from class java.util.Properties
list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames
 
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

file

java.io.File file
the file to save to


header

java.lang.String header
the header string


loaded

boolean loaded
lazy loaded on getProperty

Constructor Detail

PropertiesFile

public PropertiesFile(java.io.File file)
Create a properties object backed by the specified file.

Parameters:
file - the file to save and load to

PropertiesFile

public PropertiesFile(java.io.File file,
                      java.lang.String header)
Create a properties object backed by the specified file.

Parameters:
file - the file to save and load to
header - the file header
Method Detail

getProperty

public java.lang.String getProperty(java.lang.String key)
Returns the value of the specified key, or null if the key does not exist.

Overrides:
getProperty in class java.util.Properties

getProperty

public java.lang.String getProperty(java.lang.String key,
                                    java.lang.String defaultValue)
Returns the value of the specified key, or the default value if the key does not exist.

Overrides:
getProperty in class java.util.Properties

setProperty

public java.lang.Object setProperty(java.lang.String key,
                                    java.lang.String value)
Sets the value for the specified key.

Overrides:
setProperty in class java.util.Properties
Returns:
the previous value

getStoreFile

public java.io.File getStoreFile()
Returns the file backing this properties object.


load

public void load()
Ensures that the file backing these properties has been loaded; call this method before calling any method defined by a superclass.


store

public void store()
Saves the properties to the file.


Homepage