net.sf.jstuff.integration.config

Class INIFileConfiguration

java.lang.Object

org.apache.commons.configuration.event.EventSource

org.apache.commons.configuration.AbstractConfiguration

org.apache.commons.configuration.BaseConfiguration

org.apache.commons.configuration.AbstractFileConfiguration

net.sf.jstuff.integration.config.INIFileConfiguration

All Implemented Interfaces:

Cloneable, org.apache.commons.configuration.Configuration, org.apache.commons.configuration.FileConfiguration, org.apache.commons.configuration.FileSystemBased

public class INIFileConfiguration
extends org.apache.commons.configuration.AbstractFileConfiguration

An INI File Configuration implementation that preserves the order of comments and sections on save and supports auto sorting of sections and properties. Supported comment characters are: # and ; Supported value assignment character is =

Author:

Sebastian Thomschke

Field Summary

Fields inherited from class org.apache.commons.configuration.AbstractFileConfiguration

autoSave, basePath, EVENT_CONFIG_CHANGED, EVENT_RELOAD, fileName, reloadLock, strategy

Fields inherited from class org.apache.commons.configuration.AbstractConfiguration

END_TOKEN, EVENT_ADD_PROPERTY, EVENT_CLEAR, EVENT_CLEAR_PROPERTY, EVENT_READ_PROPERTY, EVENT_SET_PROPERTY, START_TOKEN

Constructor Summary

Constructors

Constructor and Description
INIFileConfiguration() Create a new empty INI configuration.
INIFileConfiguration(File file) Create and load the INI configuration from the given file.
INIFileConfiguration(String fileName) Create and load the INI configuration from the given file.
INIFileConfiguration(URL url) Create and load the INI configuration from the given URL.

Method Summary

Modifier and Type	Method and Description
String[]	getComments(String key)
String	getInlineComment(String key)
String	getProperty(String key)
String	getPropertyNonInterpolated(String key)
Set<String>	getSections()
boolean	isAutoSort()
protected boolean	isCommentLine(String line)
protected boolean	isSectionLine(String line)
void	load(Reader in)
protected Tuple2<String,String>	parseValueLine(String value)
void	save(Writer out)
void	setAutoSort(boolean isAutoSort)
void	setComments(String key, String... comments)
void	setProperty(String key, String value, String inlineComment)

Methods inherited from class org.apache.commons.configuration.AbstractFileConfiguration

addProperty, clearProperty, clone, closeSilent, configurationChanged, containsKey, enterNoReload, exitNoReload, fireEvent, getBasePath, getEncoding, getFile, getFileName, getFileSystem, getKeys, getPath, 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, setURL

Methods inherited from class org.apache.commons.configuration.BaseConfiguration

addPropertyDirect, clear, clearPropertyDirect

Methods inherited from class org.apache.commons.configuration.AbstractConfiguration

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, subset

Methods inherited from class org.apache.commons.configuration.event.EventSource

addConfigurationListener, addErrorListener, clearConfigurationListeners, clearErrorListeners, createErrorEvent, createEvent, fireError, getConfigurationListeners, getErrorListeners, isDetailEvents, removeConfigurationListener, removeErrorListener, setDetailEvents

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.commons.configuration.Configuration

clear, 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, subset

Constructor Detail

INIFileConfiguration

public INIFileConfiguration()

Create a new empty INI configuration.

INIFileConfiguration

public INIFileConfiguration(File file)
                     throws org.apache.commons.configuration.ConfigurationException

Create and load the INI configuration from the given file.

Parameters:

file - The INI file to load.

Throws:

org.apache.commons.configuration.ConfigurationException - If an error occurs while loading the file

INIFileConfiguration

public INIFileConfiguration(String fileName)
                     throws org.apache.commons.configuration.ConfigurationException

Create and load the INI configuration from the given file.

Parameters:

fileName - The name or path of the INI file to load.

Throws:

org.apache.commons.configuration.ConfigurationException - If an error occurs while loading the file

INIFileConfiguration

public INIFileConfiguration(URL url)
                     throws org.apache.commons.configuration.ConfigurationException

Create and load the INI configuration from the given URL.

Parameters:

url - The URL of the INI file to load.

Throws:

org.apache.commons.configuration.ConfigurationException - If an error occurs while loading the file

Method Detail

getComments

public String[] getComments(String key)

Returns:

the comments for the given section / property

getInlineComment

public String getInlineComment(String key)

Returns:

the inline comment for the given property

getProperty

public String getProperty(String key)

Specified by:

getProperty in interface org.apache.commons.configuration.Configuration

Overrides:

getProperty in class org.apache.commons.configuration.AbstractFileConfiguration

getPropertyNonInterpolated

public String getPropertyNonInterpolated(String key)

getSections

public Set<String> getSections()

isAutoSort

public boolean isAutoSort()

isCommentLine

protected boolean isCommentLine(String line)

isSectionLine

protected boolean isSectionLine(String line)

load

public void load(Reader in)
          throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

parseValueLine

protected Tuple2<String,String> parseValueLine(String value)

Returns:

Tuple[value, inlineComment]

save

public void save(Writer out)
          throws org.apache.commons.configuration.ConfigurationException

Throws:

org.apache.commons.configuration.ConfigurationException

setAutoSort

public void setAutoSort(boolean isAutoSort)

setComments

public void setComments(String key,
                        String... comments)

Parameters:

comments - the comments for the given section / property

setProperty

public void setProperty(String key,
                        String value,
                        String inlineComment)