Package net.sf.antcontrib.inifile
Class IniFile
java.lang.Object
net.sf.antcontrib.inifile.IniFile
Class representing a windows style .ini file.
- Author:
- Matthew Inger
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetProperty
(String section, String property) Gets a named property from a specific sectiongetSection
(String name) Gets the IniSection with the given nameGets the List of IniSection objects contained in this IniFilevoid
Reads from a Reader into the current IniFile instance.void
removeProperty
(String section, String property) Removes a property from a section.void
removeSection
(String name) Removes an entire section from the IniFilevoid
setProperty
(String section, String property, String value) Sets the value of a property in a given section.void
setSection
(IniSection section) Sets an IniSection object.void
Writes the current iniFile instance to a Writer object for serialization.
-
Constructor Details
-
IniFile
public IniFile()Create a new IniFile object
-
-
Method Details
-
getSections
Gets the List of IniSection objects contained in this IniFile- Returns:
- a List of IniSection objects
-
getSection
Gets the IniSection with the given name- Parameters:
name
- the name of the section
-
setSection
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.
-
removeSection
Removes an entire section from the IniFile- Parameters:
name
- The name of the section to remove
-
getProperty
Gets a named property from a specific section- Parameters:
section
- The name of the sectionproperty
- The name of the property- Returns:
- The property value, or null, if either the section or property does not exist.
-
setProperty
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 sectionproperty
- The name of the propertyvalue
- The value of the property
-
removeProperty
Removes a property from a section.- Parameters:
section
- The name of the sectionproperty
- The name of the property
-
write
Writes the current iniFile instance to a Writer object for serialization.- Parameters:
writer
- The writer to write to- Throws:
IOException
-
read
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
-