net.sf.antcontrib.inifile

Class IniFile

public class IniFile extends Object

Class representing a windows style .ini file.

Author: Matthew Inger

Constructor Summary
IniFile()
Create a new IniFile object
Method Summary
StringgetProperty(String section, String property)
Gets a named property from a specific section
IniSectiongetSection(String name)
Gets the IniSection with the given name
ListgetSections()
Gets the List of IniSection objects contained in this IniFile
voidread(Reader reader)
Reads from a Reader into the current IniFile instance.
voidremoveProperty(String section, String property)
Removes a property from a section.
voidremoveSection(String name)
Removes an entire section from the IniFile
voidsetProperty(String section, String property, String value)
Sets the value of a property in a given section.
voidsetSection(IniSection section)
Sets an IniSection object.
voidwrite(Writer writer)
Writes the current iniFile instance to a Writer object for serialization.

Constructor Detail

IniFile

public IniFile()
Create a new IniFile object

Method Detail

getProperty

public String getProperty(String section, String property)
Gets a named property from a specific section

Parameters: section The name of the section property The name of the property

Returns: The property value, or null, if either the section or property does not exist.

getSection

public IniSection getSection(String name)
Gets the IniSection with the given name

Parameters: name the name of the section

getSections

public List getSections()
Gets the List of IniSection objects contained in this IniFile

Returns: a List of IniSection objects

read

public void read(Reader reader)
Reads from a Reader into the current IniFile instance. Reading appends to the current instance, so if the current instance has properties, those properties will still exist.

Parameters: reader The reader to read from.

Throws: IOException

removeProperty

public void removeProperty(String section, String property)
Removes a property from a section.

Parameters: section The name of the section property The name of the property

removeSection

public void removeSection(String name)
Removes an entire section from the IniFile

Parameters: name The name of the section to remove

setProperty

public void setProperty(String section, String property, String value)
Sets the value of a property in a given section. If the section does not exist, it is automatically created.

Parameters: section The name of the section property The name of the property value The value of the property

setSection

public void setSection(IniSection section)
Sets an IniSection object. If a section with the given name already exists, it is replaced with the passed in section.

Parameters: section The section to set.

write

public void write(Writer writer)
Writes the current iniFile instance to a Writer object for serialization.

Parameters: writer The writer to write to

Throws: IOException