org.mmbase.util
Class ExtendedProperties

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<Object,Object>
          java.util.Properties
              org.mmbase.util.ExtendedProperties

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class ExtendedProperties
extends Properties

This is a flexible Properties version, it can handle saving of Properties with the comments that will stay in your file.

Version:

$Id: ExtendedProperties.java 41182 2010-02-26 12:21:32Z michiel $

Author:

Jan van Oosterom

See Also:

Serialized Form

Field Summary

protected String

commentPrefix The prefix of the comment in the Properties file.

Fields inherited from class java.util.Properties

defaults

Constructor Summary

ExtendedProperties()
Extended Properties constructor

ExtendedProperties(ExtendedProperties exProp)
Create an ExtendedProperties with a Allready filled ExtendedProperty list.

ExtendedProperties(String filename)
Create and read an ExtendedProperty from file.

Method Summary

Vector<String>	getPropertyValues(String whichProp, String delimeter) return a Vector of Strings which is parsed from a specified Property.
void	getProps(String filename) Read to this Property, the Properties from a file.
void	load(InputStream in) Loads properties from an InputStream.
Hashtable<Object,Object>	readProperties(String filename) Read from Properties and return them.
String	save()
void	save(String filename) This routine does not only saves your Properties but also merges your comments if the file already exists if the file doesn't exists the will call the "normal" write routine.
void	saveProperties(String filename, Hashtable<Object,Object> propsToSave) save Properties to file.
Object	setProperty(String name, String value) Set the Property.
void	showContents() Dump the contents of this Property to your screen (for debugging)

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, 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

commentPrefix

protected String commentPrefix

The prefix of the comment in the Properties file. Everything after it will be treaded as comment

Constructor Detail

ExtendedProperties

public ExtendedProperties()

Extended Properties constructor

ExtendedProperties

public ExtendedProperties(String filename)

Create and read an ExtendedProperty from file.

Parameters:

filename - The file from were to read.

ExtendedProperties

public ExtendedProperties(ExtendedProperties exProp)

Create an ExtendedProperties with a Allready filled ExtendedProperty list.

Parameters:

exProp - The list that will be put in this ExtendedProperty.

Method Detail

readProperties

public Hashtable<Object,Object> readProperties(String filename)

Read from Properties and return them.

Parameters:

filename - The file from were to read the Properties.

saveProperties

public void saveProperties(String filename,
                           Hashtable<Object,Object> propsToSave)

save Properties to file.

Parameters:

filename - The File were to save them

propsToSave - The Properties which to save.

getPropertyValues

public Vector<String> getPropertyValues(String whichProp,
                                        String delimeter)

return a Vector of Strings which is parsed from a specified Property.

Parameters:

whichProp - The Property to get the list from.

delimeter - The delimeter to split wichProp's value with.

getProps

public void getProps(String filename)
              throws IOException

Read to this Property, the Properties from a file.

Parameters:

filename - The file were to read from

Throws:

IOException

load

public void load(InputStream in)
          throws IOException

Loads properties from an InputStream. Uses "=" as delimeter between key and value. Does not uses a ":" as delimiter!

Overrides:

load in class Properties

Parameters:

in - the input stream

Throws:

IOException - Error when reading from input stream.

save

public void save(String filename)
          throws IOException

This routine does not only saves your Properties but also merges your comments if the file already exists if the file doesn't exists the will call the "normal" write routine.

Parameters:

filename - The file were to save to.

Throws:

IOException

setProperty

public Object setProperty(String name,
                          String value)

Set the Property.

Overrides:

setProperty in class Properties

Parameters:

name - the name of the Property (the part in front of the '=' in the Property file)

value - the (new) value of the Property (the part after the '=' in the Property file)

showContents

public void showContents()

Dump the contents of this Property to your screen (for debugging)

save

public String save()