de.uni_leipzig.asv.utils

Class IniFile

java.lang.Object

de.uni_leipzig.asv.utils.IniFile

public class IniFile
extends Object

An IniFile is a cache which reads some specified file of the given format. The values of the file can then be directly accessed at any time, as well as changed. Changes will immediately be written into the file. This class is not intended for massive writing, as each change requires rewriting of the whole file.

# Format of Inifiles should look like this:

# comment

[PRIMARY_KEY]
SECONDARY_KEY_1=value
SECONDARY_KEY_2=value

Author:

Stefan Bordag

See Also:

de.uni_leipzig.asv.bordag.sgz.util.IniReader, de.uni_leipzig.asv.bordag.sgz.util.IniWriter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSIGNMENT
static String	COMMENT
protected Hashtable<String,Hashtable<String,String>>	entries A double Hashtable containing the structure and values of the file
protected String	file The file which was used to read the information and which is then used to write changes
static String	PKEY_LEFT_BRACKET Constants defining the format of the file
static String	PKEY_RIGHT_BRACKET

Constructor Summary

Constructors

Constructor and Description
IniFile() Default constructor, don't use it, as instances without a filename are senseless
IniFile(File file) Convenience constructor
IniFile(String fileName) Creates an instance of the IniReader and reads the file, thus cashing the data

Method Summary

Methods

Modifier and Type	Method and Description
boolean	existsKeyPair(String primKey, String secKey) Tests whtether this inifile contains a value with the given Keypair
String	getFileName() Returns the name of the file which is associated with this instance of IniFile
Hashtable	getPrimaryKey(String key) Returns a Hashtable containing all the entries belonging to the given primary key
Hashtable<String,Hashtable<String,String>>	getPrimaryKeys() Returns the whole Hashtable
String	getValue(String primaryKey, String secondaryKey) Returns the required value of the given primary key
void	setValue(String primaryKey, String secondaryKey, String value) Sets or Adds a given value to a given keypair
void	setValues(String primaryKey, Hashtable<String,String> hash) Sets the values of the entire given primary key section to the given hashtable of values
String	toString() Prints out a representation of this class

Methods inherited from class java.lang.Object

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

Field Detail

PKEY_LEFT_BRACKET

public static final String PKEY_LEFT_BRACKET

Constants defining the format of the file

See Also:

Constant Field Values

PKEY_RIGHT_BRACKET

public static final String PKEY_RIGHT_BRACKET

See Also:

Constant Field Values

ASSIGNMENT

public static final String ASSIGNMENT

See Also:

Constant Field Values

COMMENT

public static final String COMMENT

See Also:

Constant Field Values

entries

protected Hashtable<String,Hashtable<String,String>> entries

A double Hashtable containing the structure and values of the file

file

protected String file

The file which was used to read the information and which is then used to write changes

Constructor Detail

IniFile

public IniFile()

Default constructor, don't use it, as instances without a filename are senseless

IniFile

public IniFile(File file)

Convenience constructor

IniFile

public IniFile(String fileName)

Creates an instance of the IniReader and reads the file, thus cashing the data

Method Detail

getPrimaryKey

public Hashtable getPrimaryKey(String key)

Returns a Hashtable containing all the entries belonging to the given primary key

getValue

public String getValue(String primaryKey,
              String secondaryKey)

Returns the required value of the given primary key

setValues

public void setValues(String primaryKey,
             Hashtable<String,String> hash)

Sets the values of the entire given primary key section to the given hashtable of values

setValue

public void setValue(String primaryKey,
            String secondaryKey,
            String value)

Sets or Adds a given value to a given keypair

existsKeyPair

public boolean existsKeyPair(String primKey,
                    String secKey)

Tests whtether this inifile contains a value with the given Keypair

getPrimaryKeys

public Hashtable<String,Hashtable<String,String>> getPrimaryKeys()

Returns the whole Hashtable

getFileName

public String getFileName()

Returns the name of the file which is associated with this instance of IniFile

toString

public String toString()

Prints out a representation of this class

Overrides:

toString in class Object