FileConfiguration (Apache Commons Configuration 1.10 API)

All Superinterfaces:

Configuration

All Known Implementing Classes:

AbstractFileConfiguration, AbstractHierarchicalFileConfiguration, AbstractHierarchicalFileConfiguration.FileConfigurationDelegate, DefaultConfigurationBuilder, HierarchicalINIConfiguration, HierarchicalXMLConfiguration, INIConfiguration, MultiFileHierarchicalConfiguration, PatternSubtreeConfigurationWrapper, PropertiesConfiguration, PropertyListConfiguration, XMLConfiguration, XMLPropertiesConfiguration, XMLPropertyListConfiguration
```
public interface FileConfiguration
extends Configuration
```
A persistent configuration loaded and saved to a file.

Since:

1.0-rc2

Version:

$Id: FileConfiguration.java 1209883 2011-12-03 10:56:57Z oheger $

Author:

Emmanuel Bourg

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getBasePath()` Returns the base path.
`String`	`getEncoding()` Return the encoding used to store the configuration file.
`File`	`getFile()` Return the file where the configuration is stored.
`String`	`getFileName()` Return the name of the file.
`ReloadingStrategy`	`getReloadingStrategy()` Return the reloading strategy.
`URL`	`getURL()` Return the URL where the configuration is stored.
`boolean`	`isAutoSave()` Tells if properties are automatically saved to the disk.
`void`	`load()` Load the configuration from the underlying URL.
`void`	`load(File file)` Load the configuration from the specified file.
`void`	`load(InputStream in)` Load the configuration from the specified stream, using the encoding returned by `getEncoding()`.
`void`	`load(InputStream in, String encoding)` Load the configuration from the specified stream, using the specified encoding.
`void`	`load(Reader in)` Load the configuration from the specified reader.
`void`	`load(String fileName)` Locate the specified file and load the configuration.
`void`	`load(URL url)` Load the configuration from the specified URL.
`void`	`reload()` Reload the configuration.
`void`	`save()` Save the configuration.
`void`	`save(File file)` Save the configuration to the specified file.
`void`	`save(OutputStream out)` Save the configuration to the specified stream, using the encoding returned by `getEncoding()`.
`void`	`save(OutputStream out, String encoding)` Save the configuration to the specified stream, using the specified encoding.
`void`	`save(String fileName)` Save the configuration to the specified file.
`void`	`save(URL url)` Save the configuration to the specified URL.
`void`	`save(Writer out)` Save the configuration to the specified writer.
`void`	`setAutoSave(boolean autoSave)` Enable or disable the automatically saving of modified properties to the disk.
`void`	`setBasePath(String basePath)` Sets the base path.
`void`	`setEncoding(String encoding)` Set the encoding used to store the configuration file.
`void`	`setFile(File file)` Set the file where the configuration is stored.
`void`	`setFileName(String fileName)` Set the name of the file.
`void`	`setReloadingStrategy(ReloadingStrategy strategy)` Set the reloading strategy.
`void`	`setURL(URL url)` The URL where the configuration is stored.

Methods inherited from interface org.apache.commons.configuration.Configuration
addProperty, clear, clearProperty, containsKey, getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBoolean, getBoolean, getBoolean, getByte, getByte, getByte, getDouble, getDouble, getDouble, getFloat, getFloat, getFloat, getInt, getInt, getInteger, getKeys, getKeys, getList, getList, getLong, getLong, getLong, getProperties, getProperty, getShort, getShort, getShort, getString, getString, getStringArray, isEmpty, setProperty, subset

- Method Detail
  - load
```
void load()
          throws ConfigurationException
```
    Load the configuration from the underlying URL. If the URL is not specified, it attempts to locate the specified file name.
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - load
```
void load(String fileName)
          throws ConfigurationException
```
    Locate the specified file and load the configuration.
    
    Parameters:
    fileName - the name of the file loaded
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - load
```
void load(File file)
          throws ConfigurationException
```
    Load the configuration from the specified file.
    
    Parameters:
    file - the loaded file
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - load
```
void load(URL url)
          throws ConfigurationException
```
    Load the configuration from the specified URL.
    
    Parameters:
    url - the URL of the file loaded
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - load
```
void load(InputStream in)
          throws ConfigurationException
```
    Load the configuration from the specified stream, using the encoding returned by getEncoding().
    
    Parameters:
    in - the input stream
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - load
```
void load(InputStream in,
        String encoding)
          throws ConfigurationException
```
    Load the configuration from the specified stream, using the specified encoding. If the encoding is null the default encoding is used.
    
    Parameters:
    in - the input stream
    encoding - the encoding used. null to use the default encoding
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - load
```
void load(Reader in)
          throws ConfigurationException
```
    Load the configuration from the specified reader.
    
    Parameters:
    in - the reader
    
    Throws:
    
    ConfigurationException - if an error occurs during the load operation
  - save
```
void save()
          throws ConfigurationException
```
    Save the configuration.
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - save
```
void save(String fileName)
          throws ConfigurationException
```
    Save the configuration to the specified file.
    
    Parameters:
    fileName - the name of the file to be saved
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - save
```
void save(File file)
          throws ConfigurationException
```
    Save the configuration to the specified file.
    
    Parameters:
    file - specifies the file to be saved
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - save
```
void save(URL url)
          throws ConfigurationException
```
    Save the configuration to the specified URL.
    
    Parameters:
    url - the URL
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - save
```
void save(OutputStream out)
          throws ConfigurationException
```
    Save the configuration to the specified stream, using the encoding returned by getEncoding().
    
    Parameters:
    out - the output stream
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - save
```
void save(OutputStream out,
        String encoding)
          throws ConfigurationException
```
    Save the configuration to the specified stream, using the specified encoding. If the encoding is null the default encoding is used.
    
    Parameters:
    out - the output stream
    encoding - the encoding to be used
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - save
```
void save(Writer out)
          throws ConfigurationException
```
    Save the configuration to the specified writer.
    
    Parameters:
    out - the writer
    
    Throws:
    
    ConfigurationException - if an error occurs during the save operation
  - getFileName
```
String getFileName()
```
    Return the name of the file.
    
    Returns:
    the file name
  - setFileName
```
void setFileName(String fileName)
```
    Set the name of the file.
    
    Parameters:
    fileName - the name of the file
  - getBasePath
```
String getBasePath()
```
    Returns the base path. One way to specify the location of a configuration source is by setting its base path and its file name. This method returns this base path. The concrete value returned by this method depends on the way the location of the configuration file was set. If methods like setFile() or setURL() were used, the base path typically points to the parent directory of the configuration file (e.g. for the URL file:/temp/test.properties the base path will be file:/temp/). If the base path was explicitly set using setBasePath(), this method will return the exact value specified here without further modifications.
    
    Returns:
    the base path
    See Also:
    AbstractFileConfiguration.setBasePath(String)
  - setBasePath
```
void setBasePath(String basePath)
```
    Sets the base path. The methods setBasePath() and setFileName() can be used together to specify the location of the configuration file to be loaded. If relative file names are to be resolved (e.g. for the include files supported by PropertiesConfiguration), this base path will be used.
    
    Parameters:
    basePath - the base path.
  - getFile
```
File getFile()
```
    Return the file where the configuration is stored.
    
    Returns:
    the configuration file
  - setFile
```
void setFile(File file)
```
    Set the file where the configuration is stored.
    
    Parameters:
    file - the file
  - getURL
```
URL getURL()
```
    Return the URL where the configuration is stored.
    
    Returns:
    the URL of the configuration
  - setURL
```
void setURL(URL url)
```
    The URL where the configuration is stored.
    
    Parameters:
    url - the URL
  - setAutoSave
```
void setAutoSave(boolean autoSave)
```
    Enable or disable the automatically saving of modified properties to the disk.
    
    Parameters:
    autoSave - true to enable, false to disable
    Since:
    
    1.1
  - isAutoSave
```
boolean isAutoSave()
```
    Tells if properties are automatically saved to the disk.
    
    Returns:
    true if auto-saving is enabled, false otherwise
    Since:
    
    1.1
  - getReloadingStrategy
```
ReloadingStrategy getReloadingStrategy()
```
    Return the reloading strategy.
    
    Returns:
    the reloading strategy currently used
    Since:
    
    1.1
  - setReloadingStrategy
```
void setReloadingStrategy(ReloadingStrategy strategy)
```
    Set the reloading strategy.
    
    Parameters:
    strategy - the reloading strategy to use
    Since:
    
    1.1
  - reload
```
void reload()
```
    Reload the configuration.
    
    Since:
    
    1.1
  - getEncoding
```
String getEncoding()
```
    Return the encoding used to store the configuration file. If the value is null the default encoding is used.
    
    Returns:
    the current encoding
    Since:
    
    1.1
  - setEncoding
```
void setEncoding(String encoding)
```
    Set the encoding used to store the configuration file. Set the encoding to null to use the default encoding.
    
    Parameters:
    encoding - the encoding to use
    Since:
    
    1.1

Interface FileConfiguration

Method Summary

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

Method Detail

load

load

load

load

load

load

load

save

save

save

save

save

save

save

getFileName

setFileName

getBasePath

setBasePath

getFile

setFile

getURL

setURL

setAutoSave

isAutoSave

getReloadingStrategy

setReloadingStrategy

reload

getEncoding

setEncoding