Configuration, FileConfiguration, FileSystemBased@Deprecated public class INIConfiguration extends AbstractFileConfiguration
An initialization or ini file is a configuration file typically found on Microsoft's Windows operating system and contains data for Windows based applications.
Although popularized by Windows, ini files can be used on any system or platform due to the fact that they are merely text files that can easily be parsed and modified by both humans and computers.
A typical ini file could look something like:
[section1] ; this is a comment! var1 = foo var2 = bar [section2] var1 = doo
The format of ini files is fairly straight forward and is composed of three
components:
key = value format.There are various implementations of the ini file format by various vendors which has caused a number of differences to appear. As far as possible this configuration tries to be lenient and support most of the differences.
Some of the differences supported are as follows:
var1 : foo.Global parameters are also allowed; any parameters declared before a section is declared are added to a global section. It is important to note that this global section does not have a name.
In all instances, a parameter's key is prepended with its section name and a
'.' (period). Thus a parameter named "var1" in "section1" will have the key
section1.var1 in this configuration. Thus, a section's
parameters can easily be retrieved using the subset method
using the section name as the prefix.
default = ok [section1] var1 = foo var2 = doodle [section2] ; a comment var1 = baz var2 = shoodle bad = = worse [section3] # another comment var1 : foo var2 : bar var5 : test1 [section3] var3 = foo var4 = bar var5 = test2
This ini file will be parsed without error. Note:
getProperty("default").getProperty("section1.var1").getProperty("section2."), notice the period '.' following the
section name.
The set of sections in this configuration can be retrieved using the
getSections method.
Note: Configuration objects of this type can be read concurrently by multiple threads. However if one of these threads modifies the object, synchronization has to be performed manually.
| Modifier and Type | Field | Description |
|---|---|---|
protected static java.lang.String |
COMMENT_CHARS |
Deprecated.
The characters that signal the start of a comment line.
|
protected static java.lang.String |
SEPARATOR_CHARS |
Deprecated.
The characters used to separate keys from values.
|
END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKENautoSave, basePath, EVENT_CONFIG_CHANGED, EVENT_RELOAD, fileName, reloadLock, strategy| Constructor | Description |
|---|---|
INIConfiguration() |
Deprecated.
Create a new empty INI Configuration.
|
INIConfiguration(java.io.File file) |
Deprecated.
Create and load the ini configuration from the given file.
|
INIConfiguration(java.lang.String filename) |
Deprecated.
Create and load the ini configuration from the given file.
|
INIConfiguration(java.net.URL url) |
Deprecated.
Create and load the ini configuration from the given url.
|
| Modifier and Type | Method | Description |
|---|---|---|
java.util.Set<java.lang.String> |
getSections() |
Deprecated.
Return a set containing the sections in this ini configuration.
|
protected boolean |
isCommentLine(java.lang.String line) |
Deprecated.
Determine if the given line is a comment line.
|
protected boolean |
isSectionLine(java.lang.String line) |
Deprecated.
Determine if the given line is a section.
|
void |
load(java.io.Reader reader) |
Deprecated.
Load the configuration from the given reader.
|
void |
save(java.io.Writer writer) |
Deprecated.
Save the configuration to the specified writer.
|
addErrorLogListener, append, copy, createInterpolator, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDefaultListDelimiter, getDelimiter, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getInterpolator, getKeys, getList, getList, getListDelimiter, getLogger, getLong, getLong, getLong, getProperties, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, getSubstitutor, interpolate, interpolate, interpolatedConfiguration, interpolateHelper, isDelimiterParsingDisabled, isScalarValue, isThrowExceptionOnMissing, resolveContainerStore, setDefaultListDelimiter, setDelimiter, setDelimiterParsingDisabled, setListDelimiter, setLogger, setThrowExceptionOnMissing, subsetaddProperty, clearProperty, clone, closeSilent, configurationChanged, containsKey, enterNoReload, exitNoReload, fireEvent, getBasePath, getEncoding, getFile, getFileName, getFileSystem, getKeys, getPath, getProperty, getReloadingStrategy, getReloadLock, getURL, isAutoSave, isEmpty, load, load, load, load, load, load, possiblySave, refresh, reload, reload, resetFileSystem, save, save, save, save, save, save, setAutoSave, setBasePath, setEncoding, setFile, setFileName, setFileSystem, setPath, setProperty, setReloadingStrategy, setURLaddPropertyDirect, clear, clearPropertyDirectclear, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getShort, getShort, getShort, getString, getString, getStringArray, subsetaddConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEventsprotected static final java.lang.String COMMENT_CHARS
protected static final java.lang.String SEPARATOR_CHARS
public INIConfiguration()
public INIConfiguration(java.lang.String filename) throws ConfigurationException
filename - The name pr path of the ini file to load.ConfigurationException - If an error occurs while loading the filepublic INIConfiguration(java.io.File file) throws ConfigurationException
file - The ini file to load.ConfigurationException - If an error occurs while loading the filepublic INIConfiguration(java.net.URL url) throws ConfigurationException
url - The url of the ini file to load.ConfigurationException - If an error occurs while loading the filepublic void save(java.io.Writer writer) throws ConfigurationException
writer - - The writer to save the configuration to.ConfigurationException - If an error occurs while writing the
configurationpublic void load(java.io.Reader reader) throws ConfigurationException
clear() method is not called so the configuration read in
will be merged with the current configuration.reader - The reader to read the configuration from.ConfigurationException - If an error occurs while reading the
configurationprotected boolean isCommentLine(java.lang.String line)
line - The line to check.protected boolean isSectionLine(java.lang.String line)
line - The line to check.public java.util.Set<java.lang.String> getSections()