Package | Description |
---|---|
fmpp.localdatabuilders |
fmpp.LocalDataBuilder implementations. |
fmpp.setting |
FMPP settings.
|
Modifier and Type | Method and Description |
---|---|
static BshLocalDataBuilder |
BshLocalDataBuilder.createInstanceForSetting(java.lang.String fName,
java.util.List params) |
Modifier and Type | Method and Description |
---|---|
void |
Settings.add(java.util.Map settingMap)
Adds all name-value pairs stored in the map with
Settings.add(String, Object) . |
void |
Settings.add(java.lang.String name,
java.lang.Object value)
Adds a setting value.
|
void |
Settings.addDefault(java.lang.String name,
java.lang.Object value)
Adds a setting value with low priority.
|
void |
Settings.addDefaults(java.util.Map settingMap)
Adds all entries stored in the map with
Settings.addDefault(String, Object) . |
void |
Settings.addDefaultsWithStrings(java.util.Properties props)
Same as
Settings.addDefaults(Map) , but uses a Properties
object, so the values are strings. |
void |
Settings.addDefaultWithString(java.lang.String name,
java.lang.String value)
Same as
Settings.addDefault(String, Object) , but uses string value. |
void |
Settings.addWithString(java.lang.String name,
java.lang.String value)
Same as
Settings.add(String, Object) , but uses string value that will be interpreted by
Settings.SettingType.parse(fmpp.setting.Settings, java.lang.String, boolean) . |
void |
Settings.addWithStrings(java.util.Properties props)
Same as
Settings.add(Map) , but uses a Properties object,
so the values are strings. |
protected abstract java.lang.Object |
Settings.SettingType.convert(Settings settings,
java.lang.Object value)
Converts an object to the type of the setting.
|
void |
Settings.define(java.lang.String name,
Settings.SettingType type,
boolean merge,
boolean forceStr)
Defines a new setting.
|
protected void |
Settings.doProcessing(Engine eng,
java.io.File[] sources,
java.io.File sourceFile,
java.io.File outputFile)
Executes the processing session(s) on the
Engine level,
using the already initialized Engine object. |
void |
Settings.execute()
Executes a processing session based on the setting values.
|
static void |
Settings.fixVersion08SettingNames(java.util.Properties props)
Backward compatibility hack: renames properties that use
pre-FMPP 0.9.0 names of settings.
|
void |
Settings.load(java.io.File cfgFile)
Loads settings from a configuration file.
|
void |
Settings.loadDefaults(java.io.File cfgFile)
Same as
load , except that it adds the settings with
Settings.addDefaults(Map) . |
protected abstract java.lang.Object |
Settings.SettingType.merge(Settings settings,
java.lang.Object defValue,
java.lang.Object value)
Merges two setting values.
|
protected abstract java.lang.Object |
Settings.SettingType.parse(Settings settings,
java.lang.String value,
boolean forceStr)
Converts a string value to the type of the setting.
|
static int |
Settings.quietSettingValueToInt(java.lang.String value,
java.lang.String name)
Returns 0 for verbose mode, 1 for quiet mode, 2 for really-quiet mode.
|
void |
Settings.set(java.util.Map settingValues)
Calls
Settings.set(String, Object) for each name-value pair of the Map . |
void |
Settings.set(java.lang.String name,
boolean value)
Convenience method for setting a
Boolean value. |
void |
Settings.set(java.lang.String name,
int value)
Convenience method for setting an
Integer value. |
void |
Settings.set(java.lang.String name,
java.lang.Object value)
Sets the value of a setting.
|
void |
Settings.setDefault(java.lang.String name,
boolean value)
Convenience method for setting a
Boolean value; see Settings.setDefault(String, Object) . |
void |
Settings.setDefault(java.lang.String name,
int value)
Convenience method for setting an
Integer value; see Settings.setDefault(String, Object) . |
void |
Settings.setDefault(java.lang.String name,
java.lang.Object value)
Sets the value of a setting if the value wasn't set yet.
|
void |
Settings.setDefaults(java.util.Map settingValues)
Similar to
Settings.set(Map) , but calls Settings.setDefault(String, Object) instead of
Settings.set(String, Object) . |
void |
Settings.setDefaultsWithStrings(java.util.Properties props)
Similar to
Settings.setWithStrings(Properties) , but calls Settings.setDefaultWithString(String, String) instead
of Settings.setWithString(String, String) . |
void |
Settings.setDefaultWithString(java.lang.String name,
java.lang.String value)
Same as
Settings.setDefault(String, Object) , but uses a string value that will be parsed with
Settings.SettingType.parse(fmpp.setting.Settings, java.lang.String, boolean) . |
void |
Settings.setWithString(java.lang.String name,
java.lang.String value)
Same as
Settings.set(String, Object) , but uses string value that will be parsed with
Settings.SettingType.parse(fmpp.setting.Settings, java.lang.String, boolean) . |
void |
Settings.setWithStrings(java.util.Properties props)
Calls
Settings.setWithString(String, String) for each name-value pair of the Properties . |
void |
Settings.undashNames(java.util.Properties props)
Converts legacy dashed setting names to the standard format, as
source-root to sourceRoot . |
Constructor and Description |
---|
Settings(java.io.File baseDir)
Creates a new instance.
|