Summary: Fields | Ctors | Methods | Inherited Methods | [Expand All]

public class

Properties

extends Hashtable<K, V>

java.lang.Object
↳	java.util.Dictionary<K, V>
	↳	java.util.Hashtable<K, V>
		↳	java.util.Properties

Known Direct Subclasses

Provider

Known Indirect Subclasses

AuthProvider

Class Overview

Properties is a Hashtable where the keys and values must be Strings. Each Properties can have a default Properties which specifies the default values which are used if the key is not in this Properties.

Summary

Fields
protected Properties	defaults	The default values for this Properties.

Public Constructors
	Properties() Constructs a new Properties object.
	Properties(Properties properties) Constructs a new Properties object using the specified default properties.

Public Methods
String	getProperty(String name, String defaultValue) Searches for the property with the specified name.
String	getProperty(String name) Searches for the property with the specified name.
void	list(PrintStream out) Lists the mappings in this Properties to the specified PrintStream in a human readable form.
void	list(PrintWriter writer) Lists the mappings in this Properties to the specified PrintWriter in a human readable form.
synchronized void	load(InputStream in) Loads properties from the specified InputStream.
synchronized void	loadFromXML(InputStream in)
Enumeration<?>	propertyNames() Returns all of the property names that this Properties contains.
void	save(OutputStream out, String comment) This method is deprecated. Does not throw an IOException, use store(OutputStream, String)
Object	setProperty(String name, String value) Maps the specified key to the specified value.
synchronized void	store(OutputStream out, String comment) Stores the mappings in this Properties to the specified OutputStream, putting the specified comment at the beginning.
void	storeToXML(OutputStream os, String comment)
synchronized void	storeToXML(OutputStream os, String comment, String encoding)

[Expand]

Inherited Methods

From class java.util.Hashtable

synchronized void	clear() Removes all key/value pairs from this Hashtable, leaving the size zero and the capacity unchanged.
synchronized Object	clone() Returns a new Hashtable with the same key/value pairs, capacity and load factor.
synchronized boolean	contains(Object value) Returns if this Hashtable contains the specified object as the value of at least one of the key/value pairs.
synchronized boolean	containsKey(Object key) Returns if this Hashtable contains the specified object as a key of one of the key/value pairs.
boolean	containsValue(Object value) Searches this Hashtable for the specified value.
synchronized Enumeration<V>	elements() Returns an Enumeration on the values of this Hashtable.
Set<Entry<K, V>>	entrySet() Returns a Set of the mappings contained in this Hashtable.
synchronized boolean	equals(Object object) Compares the specified object to this Hashtable and answer if they are equal.
synchronized V	get(Object key) Returns the value associated with the specified key in this Hashtable.
synchronized int	hashCode() Returns an integer hash code for the receiver.
synchronized boolean	isEmpty() Returns if this Hashtable has no key/value pairs, a size of zero.
Set<K>	keySet() Returns a Set of the keys contained in this Hashtable.
synchronized Enumeration<K>	keys() Returns an Enumeration on the keys of this Hashtable.
synchronized V	put(K key, V value) Associate the specified value with the specified key in this Hashtable.
synchronized void	putAll(Map<? extends K, ? extends V> map) Copies every mapping in the specified Map to this Hashtable.
void	rehash() Increases the capacity of this Hashtable.
synchronized V	remove(Object key) Remove the key/value pair with the specified key from this Hashtable.
synchronized int	size() Returns the number of key/value pairs in this Hashtable.
synchronized String	toString() Returns the string representation of this Hashtable.
Collection<V>	values() Returns a Collection of the values contained in this Hashtable.

From class java.util.Dictionary

From class java.lang.Object

Object	clone() Returns a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
void	finalize() Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final Class<? extends Object>	getClass() Returns the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode() Returns an integer hash code for the receiver.
final void	notify() Causes one thread which is `wait` ing on the receiver to be made ready to run.
final void	notifyAll() Causes all threads which are `wait` ing on the receiver to be made ready to run.
String	toString() Returns a string containing a concise, human-readable description of the receiver.
final void	wait(long time, int frac) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait(long time) Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final void	wait() Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

From interface java.util.Map

abstract void	clear() Removes all elements from this Map, leaving it empty.
abstract boolean	containsKey(Object key) Searches this Map for the specified key.
abstract boolean	containsValue(Object value) Searches this Map for the specified value.
abstract Set<Entry<K, V>>	entrySet() Returns a `Set` whose elements comprise all of the mappings that are to be found in this `Map`.
abstract boolean	equals(Object object) Compares the argument to the receiver, and returns true if they represent the same object using a class specific comparison.
abstract V	get(Object key) Returns the value of the mapping with the specified key.
abstract int	hashCode() Returns an integer hash code for the receiver.
abstract boolean	isEmpty() Returns if this Map has no elements, a size of zero.
abstract Set<K>	keySet() Returns a Set of the keys contained in this Map.
abstract V	put(K key, V value) Maps the specified key to the specified value.
abstract void	putAll(Map<? extends K, ? extends V> map) Copies every mapping in the specified Map to this Map.
abstract V	remove(Object key) Removes a mapping with the specified key from this Map.
abstract int	size() Returns the number of elements in this Map.
abstract Collection<V>	values() Returns all of the current `Map` values in a `Collection`.

Fields

protected Properties defaults

The default values for this Properties.

Public Constructors

public Properties ()

Constructs a new Properties object.

public Properties (Properties properties)

Constructs a new Properties object using the specified default properties.

Parameters

properties	the default properties

Public Methods

public String getProperty (String name, String defaultValue)

Searches for the property with the specified name. If the property is not found, look in the default properties. If the property is not found in the default properties, answer the specified default.

Parameters

name	the name of the property to find
defaultValue	the default value

Returns

the named property value

public String getProperty (String name)

Searches for the property with the specified name. If the property is not found, look in the default properties. If the property is not found in the default properties, answer null.

Parameters

name	the name of the property to find

Returns

the named property value

public void list (PrintStream out)

Lists the mappings in this Properties to the specified PrintStream in a human readable form.

Parameters

out	the PrintStream

public void list (PrintWriter writer)

Lists the mappings in this Properties to the specified PrintWriter in a human readable form.

Parameters

writer	the PrintWriter

public synchronized void load (InputStream in)

Loads properties from the specified InputStream. The properties are of the form key=value, one property per line.

Parameters

in	the input stream

Throws

IOException

public synchronized void loadFromXML (InputStream in)

Throws

IOException
InvalidPropertiesFormatException

public Enumeration<?> propertyNames ()

Returns all of the property names that this Properties contains.

Returns

an Enumeration containing the names of all properties

public void save (OutputStream out, String comment)

This method is deprecated.Does not throw an IOException, use store(OutputStream, String)

Saves the mappings in this Properties to the specified OutputStream, putting the specified comment at the beginning. The output from this method is suitable for being read by the load() method.

Parameters

out	the OutputStream
comment	the comment

Throws

ClassCastException	when the key or value of a mapping is not a String

public Object setProperty (String name, String value)

Maps the specified key to the specified value. If the key already exists, the old value is replaced. The key and value cannot be null.

Parameters

name	the key
value	the value

Returns

the old value mapped to the key, or null

public synchronized void store (OutputStream out, String comment)

Stores the mappings in this Properties to the specified OutputStream, putting the specified comment at the beginning. The output from this method is suitable for being read by the load() method.

Parameters

out	the OutputStream
comment	the comment

Throws

IOException
ClassCastException	when the key or value of a mapping is not a String

public void storeToXML (OutputStream os, String comment)

Throws

IOException

public synchronized void storeToXML (OutputStream os, String comment, String encoding)

Throws

IOException

Jan	FEB	Mar
	18
2008	2009	2010

Interfaces

Classes

Enums

Exceptions

Properties

Class Overview

See Also

Summary

Fields

protected Properties defaults

Public Constructors

public Properties ()

public Properties (Properties properties)

Parameters

Public Methods

public String getProperty (String name, String defaultValue)

Parameters

Returns

public String getProperty (String name)

Parameters

Returns

public void list (PrintStream out)

Parameters

public void list (PrintWriter writer)

Parameters

public synchronized void load (InputStream in)

Parameters

Throws

public synchronized void loadFromXML (InputStream in)

Throws

public Enumeration<?> propertyNames ()

Returns

public void save (OutputStream out, String comment)

Parameters

Throws

public Object setProperty (String name, String value)

Parameters

Returns

public synchronized void store (OutputStream out, String comment)

Parameters

Throws

public void storeToXML (OutputStream os, String comment)

Throws

public synchronized void storeToXML (OutputStream os, String comment, String encoding)

Throws