com.highqsoft.fwk.util

Class IniFileSection

java.lang.Object

com.highqsoft.fwk.util.IniFileSection

public class IniFileSection
extends java.lang.Object

IniFiles are composed by sections. All comments and empty lines before a section definition are treated as comments of the section. Each section may contain an arbitrary number of entries. The entry type is either an entry, a comment or a blank line.

Since:

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

Version:

$Revision: 1.12 $

Author:

HighQSoft GmbH

Field Summary

Fields

Modifier and Type	Field and Description
protected static FwkDescriptionInterface	descriptor
protected java.util.Hashtable	sectionEntryHash
protected java.util.ArrayList	sectionEntryList
protected java.lang.String	sectionName
static java.lang.String	version

Constructor Summary

Constructors

Constructor and Description
IniFileSection()

Method Summary

Methods

Modifier and Type	Method and Description
static FwkDescriptionInterface	getDescriptor()
int	getMaximumSectionEntryNameLength() Get the length of the longest section entry name.
IniFileSectionEntry	getSectionEntry(int sectionEntryPosition) Get a section entry by position.
IniFileSectionEntry	getSectionEntry(java.lang.String name) Get a section entry by name.
int	getSectionEntryCount() Get the number of section entries.
int	getSectionEntryPosition(IniFileSectionEntry sectionEntry) Get the position of a section entry.
int	getSectionEntryPosition(java.lang.String name) Get the position of a section entry.
java.lang.String	getSectionName() Get the section name.
java.lang.String	getVersion()
void	removeSectionEntry(IniFileSectionEntry sectionEntry) Remove a section entry.
void	removeSectionEntry(int sectionEntryPosition) Remove a section entry by position. !!!!!!!
void	removeSectionEntry(java.lang.String name) Remove a section entry by name.
void	renameSectionEntry(java.lang.String oldName, java.lang.String newName) Rename a section entry.
IniFileSectionEntry	setSectionComment(java.lang.String comment) Set or create a section comment.
void	setSectionEntry(IniFileSectionEntry sectionEntry) Set or create a section entry.
IniFileSectionEntry	setSectionEntry(java.lang.String name, java.lang.String value) Set or create a section entry.
void	setSectionName(java.lang.String sectionName) Set the section name.
void	sortSectionEntries(boolean ascending) Sort the section entries. !!!!!!!

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

sectionEntryList

protected java.util.ArrayList sectionEntryList

sectionEntryHash

protected java.util.Hashtable sectionEntryHash

sectionName

protected java.lang.String sectionName

Constructor Detail

IniFileSection

public IniFileSection()

Method Detail

getVersion

public java.lang.String getVersion()

getDescriptor

public static FwkDescriptionInterface getDescriptor()

getMaximumSectionEntryNameLength

public int getMaximumSectionEntryNameLength()

Get the length of the longest section entry name.

Returns:

The length of the longest section entry name.

getSectionEntry

public IniFileSectionEntry getSectionEntry(java.lang.String name)

Get a section entry by name.

Parameters:

name - The name of the requested entry.

Returns:

The section entry.

getSectionEntry

public IniFileSectionEntry getSectionEntry(int sectionEntryPosition)

Get a section entry by position.

Parameters:

sectionEntryPosition - The position of the requested entry.

Returns:

The section entry.

getSectionEntryCount

public int getSectionEntryCount()

Get the number of section entries.

Returns:

The number of section entries.

getSectionEntryPosition

public int getSectionEntryPosition(java.lang.String name)

Get the position of a section entry.

Parameters:

name - The name of the section entry.

Returns:

The position of the section entry.

getSectionEntryPosition

public int getSectionEntryPosition(IniFileSectionEntry sectionEntry)

Get the position of a section entry.

Parameters:

sectionEntry - The section entry.

Returns:

The position of the section entry.

getSectionName

public java.lang.String getSectionName()

Get the section name.

Returns:

The section name.

removeSectionEntry

public void removeSectionEntry(java.lang.String name)

Remove a section entry by name.

Parameters:

name - The name of the section entry to be removed.

removeSectionEntry

public void removeSectionEntry(int sectionEntryPosition)

Remove a section entry by position. !!!!!!! remove also preceeding comments !!!!!!!!!!!!!

Parameters:

position - The position of the section entry to be removed.

removeSectionEntry

public void removeSectionEntry(IniFileSectionEntry sectionEntry)

Remove a section entry.

Parameters:

sectionEntry - The section entry to be removed.

renameSectionEntry

public void renameSectionEntry(java.lang.String oldName,
                      java.lang.String newName)

Rename a section entry.

Parameters:

oldName - The current name of the section entry.

newName - The new name of the section entry.

setSectionComment

public IniFileSectionEntry setSectionComment(java.lang.String comment)

Set or create a section comment. If the section does not yet have a name, the comments are marked as header lines.

Parameters:

comment - The comment of the entry.

Returns:

sectionEntry The current section entry.

setSectionEntry

public IniFileSectionEntry setSectionEntry(java.lang.String name,
                                  java.lang.String value)

Set or create a section entry. If the name does not yet exist a new entry is created.

Parameters:

name - The name of the entry.

value - The value of the entry.

Returns:

sectionEntry The current section entry.

setSectionEntry

public void setSectionEntry(IniFileSectionEntry sectionEntry)

Set or create a section entry. If the name does not yet exist a new entry is created.

Parameters:

sectionEntry - The section entry.

setSectionName

public void setSectionName(java.lang.String sectionName)

Set the section name.

Parameters:

sectionName - The section name.

sortSectionEntries

public void sortSectionEntries(boolean ascending)

Sort the section entries. !!!!!!! sort also preceeding comments !!!!!!!!!!!!!

Parameters:

ascending - Sort in ascending order if true.