com.compomics.util.io

Class ConfigurationFile

java.lang.Object

com.compomics.util.io.ConfigurationFile

public class ConfigurationFile
extends Object

Generic configuration text file. TODO: replace with a json file

Author:

Marc Vaudel

Constructor Summary

Constructors

Constructor and Description
ConfigurationFile(File configurationFile) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getParameterLine(String parameterName) Returns a parameter line corresponding to the given parameter name.
void	setParameter(String parameterName, String value) Sets the value for a given parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationFile

public ConfigurationFile(File configurationFile)

Constructor.

Parameters:

configurationFile - a file where to save the configuration

Method Detail

setParameter

public void setParameter(String parameterName,
                         String value)
                  throws FileNotFoundException,
                         IOException

Sets the value for a given parameter.

Parameters:

parameterName - the name of the parameter of interest

value - the value to set

Throws:

FileNotFoundException - exception thrown whenever the connection to the file was dropped before execution is finished

IOException - exception thrown whenever an error occurred while reading or writing to the file

getParameterLine

public String getParameterLine(String parameterName)
                        throws FileNotFoundException,
                               IOException

Returns a parameter line corresponding to the given parameter name. Null if not found.

Parameters:

parameterName - the name of the parameter of interest

Returns:

line corresponding to the given parameter

Throws:

FileNotFoundException - exception thrown when the connection to the file is broken while reading

IOException - exception thrown whenever an error occurred while reading the file