prupp
Class Config

java.lang.Object
  |
  +--prupp.Config

public class Config
extends java.lang.Object

a class to handle configs for different things. reads file on the format

  [sectionName1]
  key=value
  key2=value2
  [sectionName2]
  key=value
  key2=value2 
everything after the first '#' is considered a comment. blank lines are ignored.


Constructor Summary
Config()
          create an empty Config (has only section "" with no data in it)
Config(java.lang.String filename)
          create a Config for the specified file
 
Method Summary
 java.util.Properties getProperties(java.lang.String sectionName)
          get the properties for a given section
 java.lang.String getProperty(java.lang.String section, java.lang.String key)
          get a property for given key in specified section
 java.util.Enumeration getSections()
          get the available sections
 void save(java.io.OutputStream os)
          save the config to a OutputStream
 void save(java.io.OutputStream os, java.lang.String comment)
          save the config to a OutputStream
 void setProperties(java.lang.String sectionName, java.util.Properties prop)
          set the properties for a given section
 void setProperty(java.lang.String section, java.lang.String key, java.lang.String value)
          set a property for given section.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Config

public Config()
create an empty Config (has only section "" with no data in it)

Config

public Config(java.lang.String filename)
       throws java.io.IOException
create a Config for the specified file
Parameters:
filename - the File we read the config from
Method Detail

getSections

public java.util.Enumeration getSections()
get the available sections
Returns:
an Enumeration of the available sections (including the empty section).

getProperties

public java.util.Properties getProperties(java.lang.String sectionName)
get the properties for a given section
Parameters:
sectionName - the section we want properties for.
Returns:
a Properties if section exist or null.

setProperties

public void setProperties(java.lang.String sectionName,
                          java.util.Properties prop)
set the properties for a given section
Parameters:
sectionName - the section we want to set the properties for.
prop - the Properties for the sections

getProperty

public java.lang.String getProperty(java.lang.String section,
                                    java.lang.String key)
get a property for given key in specified section
Parameters:
section - the section we should look in.
key - the key we want a value for.
Returns:
a string if section + key is set, null otherwise

setProperty

public void setProperty(java.lang.String section,
                        java.lang.String key,
                        java.lang.String value)
set a property for given section.
Parameters:
section - the section we should look in.
key - the key.
value - the value.

save

public void save(java.io.OutputStream os)
save the config to a OutputStream

save

public void save(java.io.OutputStream os,
                 java.lang.String comment)
save the config to a OutputStream