com.highqsoft.fwk.util

Class IniFile

java.lang.Object

com.highqsoft.fwk.util.IniFile

public class IniFile
extends java.lang.Object

The IniFile class allows to read, write, merge and modify initialization files. Comments within the initialization files are conserved as far as possible. A variable with a comment behind will keep this comment when changed or renamed. The comment is deleted when the variable is deleted. An INI file consists of sections and entries. The following lines demonstrate the syntax of such files:

[STARTUP]
FILENAME = file:///java/src/config.ini
PARAMS = None

[DICTIONARY]
CANCEL = Abbrechen
APPLY = Anwenden

Uppercase and lowercase letters will not be changed unless the variable is renamed. Keywords do not contain white spaces and the '=' or ':' sign.
Comments are allowed and should be lead by the following character: ';'

Since:

$Date: 2017/04/28 08:47:42 $

Version:

$Revision: 1.12 $

Author:

HighQSoft GmbH

Field Summary

Fields

Modifier and Type	Field and Description
static int	COMMENT
protected IniFileSection	currentSection
protected static FwkDescriptionInterface	descriptor
static int	EMPTY
static int	ENTRY
static int	HEADER
protected java.io.File	iniFile
protected java.util.Hashtable	sectionHash
protected java.util.ArrayList	sectionList
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
IniFile()
IniFile(java.lang.String filename) The constructor receiving the filename ot be read.
IniFile(java.net.URL url) The constructor receiving the url to be read.

Method Summary

Methods

Modifier and Type	Method and Description
static FwkDescriptionInterface	getDescriptor()
java.io.File	getFile() Get the initialization file descriptor.
int	getSectionCount() Get the number of sections ini the INI-File.
java.lang.String	getVersion()
java.util.ArrayList	listSections(java.lang.String pattern) List known service names.
static void	main(java.lang.String[] args)
protected void	parseToSection(java.lang.String line) Parse the current line and put it into the current section.
void	read(java.io.InputStreamReader fileReader) Read an initialization from stream.
void	read(java.lang.String filename) Read an initialization file.
void	read(java.net.URL url) Read an initialization file from URL.
void	write(java.lang.String filename) Write an initialzation file.

Methods inherited from class java.lang.Object

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

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

descriptor

protected static final FwkDescriptionInterface descriptor

EMPTY

public static final int EMPTY

See Also:

Constant Field Values

COMMENT

public static final int COMMENT

See Also:

Constant Field Values

HEADER

public static final int HEADER

See Also:

Constant Field Values

ENTRY

public static final int ENTRY

See Also:

Constant Field Values

sectionList

protected java.util.ArrayList sectionList

sectionHash

protected java.util.Hashtable sectionHash

currentSection

protected IniFileSection currentSection

iniFile

protected java.io.File iniFile

Constructor Detail

IniFile

public IniFile()

IniFile

public IniFile(java.lang.String filename)

The constructor receiving the filename ot be read.

Parameters:

filename - The name of the file.

IniFile

public IniFile(java.net.URL url)

The constructor receiving the url to be read.

Parameters:

url - The url of the file.

Method Detail

getVersion

public java.lang.String getVersion()

getDescriptor

public static FwkDescriptionInterface getDescriptor()

getSectionCount

public int getSectionCount()

Get the number of sections ini the INI-File.

Returns:

The number of sections.

getFile

public java.io.File getFile()

Get the initialization file descriptor.

Returns:

The initialization file descriptor.

listSections

public java.util.ArrayList listSections(java.lang.String pattern)

List known service names.

Parameters:

pattern - The filter pattern.

read

public void read(java.lang.String filename)

Read an initialization file.

Parameters:

filename - The name of the initialization file to be read.

read

public void read(java.net.URL url)

Read an initialization file from URL.

Parameters:

url - The URL to the initialization file to be read.

read

public void read(java.io.InputStreamReader fileReader)

Read an initialization from stream.

Parameters:

fileRead - The reader of the initialization file to be read.

write

public void write(java.lang.String filename)

Write an initialzation file.

Parameters:

filename - The name of the initialization file to be written.

parseToSection

protected void parseToSection(java.lang.String line)

Parse the current line and put it into the current section.

Parameters:

line - Then next line from the input file.

main

public static void main(java.lang.String[] args)