|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object rabbit.util.Config
a class to handle configs for different things. reads file on the format
[sectionName1] key=value key2=value2 [sectionName2] key=value key2=value2 key_with_equals\=still_key=value3everything after the first '#' is considered a comment. blank lines are ignored. If you want keys with '=' in them escape it to '\=' and you should be fine.
Constructor Summary | |
Config()
create an empty Config (has only section "" with no data in it) |
|
Config(java.io.File file)
Create a Config for the specified file |
|
Config(java.io.InputStream is)
Create a Config by reading it from a stream. |
|
Config(java.io.Reader reader)
Create a Config by reading it from a reader. |
|
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.lang.String |
getProperty(java.lang.String section,
java.lang.String key,
java.lang.String defaultstring)
get a property for given key in specified section |
java.util.Enumeration |
getSections()
get the available sections |
void |
merge(Config other)
Merge this config with another one. |
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. |
java.lang.String |
toString()
Get a string describing this Config |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Config()
public Config(java.lang.String filename) throws java.io.IOException
filename
- the File we read the config frompublic Config(java.io.File file) throws java.io.IOException
public Config(java.io.InputStream is) throws java.io.IOException
is
- the stream to read the config from.public Config(java.io.Reader reader) throws java.io.IOException
reader
- the Reader to read the config from.Method Detail |
public java.util.Enumeration getSections()
public java.util.Properties getProperties(java.lang.String sectionName)
sectionName
- the section we want properties for.
public void setProperties(java.lang.String sectionName, java.util.Properties prop)
sectionName
- the section we want to set the properties for.prop
- the Properties for the sectionspublic java.lang.String getProperty(java.lang.String section, java.lang.String key)
section
- the section we should look in.key
- the key we want a value for.
public java.lang.String getProperty(java.lang.String section, java.lang.String key, java.lang.String defaultstring)
section
- the section we should look in.key
- the key we want a value for.defaultstring
- the string to use if no value is found.
public void setProperty(java.lang.String section, java.lang.String key, java.lang.String value)
section
- the section we should look in.key
- the key.value
- the value.public void save(java.io.OutputStream os)
public void save(java.io.OutputStream os, java.lang.String comment)
public java.lang.String toString()
public void merge(Config other)
other
- the Config to merge with.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |