Java Doc for FileConfiguration.java in » Library » Apache-commons-configuration-1.4-src » org » apache » commons » configuration » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Library » Apache commons configuration 1.4 src » org.apache.commons.configuration

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.commons.configuration .FileConfiguration

All known Subclasses:   org.apache.commons.configuration .AbstractFileConfiguration,  org.apache.commons.configuration .AbstractHierarchicalFileConfiguration,
FileConfiguration
public interface FileConfiguration extends Configuration(Code)
A persistent configuration loaded and saved to a file.
author:
   Emmanuel Bourg
version:
   $Revision: 492234 $, $Date: 2007-01-03 18:39:39 +0100 (Mi, 03 Jan 2007) $
since:
   1.0-rc2

Method Summary
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(String fileName)
     Locate the specified file and load the configuration.
void load(File file)
     Load the configuration from the specified file.
void load(URL url)
     Load the configuration from the specified URL.
void load(InputStream in)
     Load the configuration from the specified stream, using the encoding returned by FileConfiguration.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 reload()
     Reload the configuration.
void save()
     Save the configuration.
void save(String fileName)
     Save the configuration to the specified file.
void save(File file)
     Save the configuration to the specified file.
void save(URL url)
     Save the configuration to the specified URL if it's a file URL.
void save(OutputStream out)
     Save the configuration to the specified stream, using the encoding returned by FileConfiguration.getEncoding() .
void save(OutputStream out, String encoding)
     Save the configuration to the specified stream, using the specified encoding.
void save(Writer out)
     Save the configuration to the specified writer.
void setAutoSave(boolean autoSave)
     Enable or disable the automatical 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.

Method Detail
getBasePath
String getBasePath()(Code)
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 explictly set using setBasePath(), this method will return the exact value specified here without further modifications. the base path
See Also:   AbstractFileConfiguration.setBasePath(String)

getEncoding
String getEncoding()(Code)
Return the encoding used to store the configuration file. If the value is null the default encoding is used. the current encoding
since:
   1.1

getFile
File getFile()(Code)
Return the file where the configuration is stored. the configuration file

getFileName
String getFileName()(Code)
Return the name of the file. the file name

getReloadingStrategy
ReloadingStrategy getReloadingStrategy()(Code)
Return the reloading strategy. the reloading strategy currently used
since:
   1.1

getURL
URL getURL()(Code)
Return the URL where the configuration is stored. the URL of the configuration

isAutoSave
boolean isAutoSave()(Code)
Tells if properties are automatically saved to the disk. true if auto-saving is enabled, false otherwise
since:
   1.1

load
void load() throws ConfigurationException(Code)
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(Code)
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(Code)
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(Code)
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(Code)
Load the configuration from the specified stream, using the encoding returned by FileConfiguration.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(Code)
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
Parameters:
  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(Code)
Load the configuration from the specified reader.
Parameters:
  in - the reader
throws:
  ConfigurationException - if an error occurs during the load operation

reload
void reload()(Code)
Reload the configuration.
since:
   1.1

save
void save() throws ConfigurationException(Code)
Save the configuration.
throws:
  ConfigurationException - if an error occurs during the save operation

save
void save(String fileName) throws ConfigurationException(Code)
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(Code)
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(Code)
Save the configuration to the specified URL if it's a file URL.
Parameters:
  url - the URL
throws:
  ConfigurationException - if an error occurs during the save operation

save
void save(OutputStream out) throws ConfigurationException(Code)
Save the configuration to the specified stream, using the encoding returned by FileConfiguration.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(Code)
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
Parameters:
  encoding - the encoding to be used
throws:
  ConfigurationException - if an error occurs during the save operation

save
void save(Writer out) throws ConfigurationException(Code)
Save the configuration to the specified writer.
Parameters:
  out - the writer
throws:
  ConfigurationException - if an error occurs during the save operation

setAutoSave
void setAutoSave(boolean autoSave)(Code)
Enable or disable the automatical saving of modified properties to the disk.
Parameters:
  autoSave - true to enable, false to disable
since:
   1.1

setBasePath
void setBasePath(String basePath)(Code)
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.

setEncoding
void setEncoding(String encoding)(Code)
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

setFile
void setFile(File file)(Code)
Set the file where the configuration is stored.
Parameters:
  file - the file

setFileName
void setFileName(String fileName)(Code)
Set the name of the file.
Parameters:
  fileName - the name of the file

setReloadingStrategy
void setReloadingStrategy(ReloadingStrategy strategy)(Code)
Set the reloading strategy.
Parameters:
  strategy - the reloading strategy to use
since:
   1.1

setURL
void setURL(URL url)(Code)
The URL where the configuration is stored.
Parameters:
  url - the URL

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.