|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.webmacro.util.Settings
Nested Class Summary | |
static class |
Settings.ListSettingHandler
|
Field Summary | |
protected static java.lang.String[] |
stringArray
|
Constructor Summary | |
|
Settings()
Create an empty Settings object |
protected |
Settings(java.util.Properties values)
Instantiate a new Settings object using the properties supplied as the settings values. |
|
Settings(Settings defaults)
Instantaite a new Settings object using the supplied Settings as the defaults |
|
Settings(java.lang.String settingsFile)
Search for the named settingsFile on the classpath and instantiate a Settings object based on its values |
|
Settings(java.net.URL settingsFile)
Search for the named settingsFile from the supplied URL and instantiate a Settings object based on its values |
Method Summary | |
boolean |
containsKey(java.lang.String key)
Find out if a setting is defined |
java.util.Properties |
getAsProperties()
Get the values from this settings object as a properties |
boolean |
getBooleanSetting(java.lang.String key)
Get a setting and convert it to a boolean. |
boolean |
getBooleanSetting(java.lang.String key,
boolean defaultValue)
Get a setting with a default value in case it is not set |
int |
getIntegerSetting(java.lang.String key)
Get a setting and convert it to an int |
int |
getIntegerSetting(java.lang.String key,
int defaultValue)
Get a setting with a default value in case it is not set |
java.lang.String[] |
getKeys()
Get the keys for this settings object as an array |
java.lang.String |
getSetting(java.lang.String key)
Get a setting. |
java.lang.String |
getSetting(java.lang.String key,
java.lang.String defaultValue)
Get a setting with a default value in case it is not set |
void |
load(java.io.InputStream in)
Load settings from the supplied input stream |
void |
load(java.util.Properties props)
Load settings from a Properties |
void |
load(java.util.Properties props,
java.lang.String prefix)
Load settings from a Properties, only extracting properties which have the specified prefix |
void |
load(Settings defaults)
Load settings from a Settings |
void |
load(java.lang.String fileName)
Load settings from the supplied fileName, searching for the file along the classpath, and then search for the settings file as a file: URL. |
void |
load(java.net.URL u)
Load settings from the supplied URL |
static void |
main(java.lang.String[] arg)
Brief test |
void |
processListSetting(java.lang.String settingName,
Settings.ListSettingHandler h)
Iterate through a list of settings. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final java.lang.String[] stringArray
Constructor Detail |
public Settings()
public Settings(java.lang.String settingsFile) throws InitException, java.io.IOException
public Settings(java.net.URL settingsFile) throws InitException, java.io.IOException
protected Settings(java.util.Properties values)
public Settings(Settings defaults)
Method Detail |
public void load(java.lang.String fileName) throws InitException, java.io.IOException
InitException
java.io.IOException
public void load(java.net.URL u) throws java.io.IOException
java.io.IOException
public void load(java.io.InputStream in) throws java.io.IOException
java.io.IOException
public void load(Settings defaults)
public void load(java.util.Properties props, java.lang.String prefix)
public void load(java.util.Properties props)
public boolean containsKey(java.lang.String key)
public java.lang.String getSetting(java.lang.String key)
public java.lang.String getSetting(java.lang.String key, java.lang.String defaultValue)
public int getIntegerSetting(java.lang.String key)
public int getIntegerSetting(java.lang.String key, int defaultValue)
public boolean getBooleanSetting(java.lang.String key)
public boolean getBooleanSetting(java.lang.String key, boolean defaultValue)
public java.lang.String[] getKeys()
public java.util.Properties getAsProperties()
public void processListSetting(java.lang.String settingName, Settings.ListSettingHandler h)
public static void main(java.lang.String[] arg) throws java.lang.Exception
java.lang.Exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |