com.sun.interview
Class Properties2

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable
          com.sun.interview.Properties2

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map

public class Properties2
extends java.util.Hashtable

The Properties class represents a persistent set of properties. The Properties can be saved to a stream or loaded from a stream. Each key and its corresponding value in the property list is a string.

A property list can contain another property list as its "defaults"; this second property list is searched if the property key is not found in the original property list. This class is similar to java.util.Properties, but has upgraded capabilities.

See Also:

Serialized Form

Field Summary

protected Properties2

defaults A property list that contains default values for any keys not found in this property list.

Constructor Summary

Properties2()
Creates an empty property list with no default values.

Properties2(Properties2 defaults)
Creates an empty property list with the specified defaults.

Method Summary

java.lang.String	getProperty(java.lang.String key) Searches for the property with the specified key in this property list.
java.lang.String	getProperty(java.lang.String key, java.lang.String defaultValue) Searches for the property with the specified key in this property list.
void	list(java.io.PrintWriter out) Prints this property list out to the specified output stream.
void	load(java.util.Properties source)
void	load(java.io.Reader in) Reads a property list from an input stream.
java.util.Enumeration	propertyNames() Returns an enumeration of all the keys in this property list, including the keys in the default property list.
void	save(java.io.Writer out, java.lang.String header) Stores this property list to the specified output stream.

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

defaults

protected Properties2 defaults

A property list that contains default values for any keys not found in this property list.

Constructor Detail

Properties2

public Properties2()

Creates an empty property list with no default values.

Properties2

public Properties2(Properties2 defaults)

Creates an empty property list with the specified defaults.

Parameters:

defaults - the defaults.

Method Detail

load

public void load(java.util.Properties source)

load

public void load(java.io.Reader in)
          throws java.io.IOException

Reads a property list from an input stream.

Parameters:

in - the input stream.

Throws:

java.io.IOException - if an error occurred when reading from the input stream.

save

public void save(java.io.Writer out,
                 java.lang.String header)

Stores this property list to the specified output stream. The string header is printed as a comment at the beginning of the stream.

Parameters:

out - an output stream.

header - a description of the property list.

getProperty

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

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns null if the property is not found.

Parameters:

key - the property key.

Returns:

the value in this property list with the specified key value.

See Also:

defaults

getProperty

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

Searches for the property with the specified key in this property list. If the key is not found in this property list, the default property list, and its defaults, recursively, are then checked. The method returns the default value argument if the property is not found.

Parameters:

key - the hashtable key.

defaultValue - a default value.

Returns:

the value in this property list with the specified key value.

See Also:

defaults

propertyNames

public java.util.Enumeration propertyNames()

Returns an enumeration of all the keys in this property list, including the keys in the default property list.

Returns:

an enumeration of all the keys in this property list, including the keys in the default property list.

See Also:

Enumeration, defaults

list

public void list(java.io.PrintWriter out)

Prints this property list out to the specified output stream. This method is useful for debugging.

Parameters:

out - an output stream.