Click here to Skip to main content
Click here to Skip to main content

An Enhanced INI File Class for Java

, 4 Apr 2013
Rate this:
Please Sign up or sign in to vote.
An INI file manipulation class with support for environment variables.

Introduction

This article is about a Java class to read and write Windows INI files. One good feature of this class is its support for environment variables, i.e., this class allows us to include a reference to an environment variable while defining values in INI files. The following code snippet depicts this feature:

;Sample INI file
[Database]
UserId = DBuser
Sid = DBSid
DBHost = 145.101.56.32
DBPort = 1521
DBLib = %ORACLE_HOME%\lib\classes12.jar

When the DBLib variable is read, the class will try to retrieve the value for the %ORACLE_HOME% variable. Let's say on your system %ORACLE_HOME% points to the C:\Oracle directory, then DBLib will get expanded to C:\Oracle\lib\classes12.jar.

Using the Code

The following code snippet shows the usage of this class. The same code can also be found in the main method of the INIFile class.

public static void main(String[] pstrArgs)
{
    INIFile objINI = null;
    String  strFile = null;

    if (pstrArgs.length == 0) return;

    strFile = pstrArgs[0];
    /* Following call loads the strFile if it exists. */
    objINI = new INIFile(strFile);

    objINI.setStringProperty("Database", "SID", "ORCL");
    objINI.setStringProperty("Database", "UserId", "System");
    objINI.setStringProperty("Database", "Password", "Manager");
    objINI.setStringProperty("Database", "HostName", "DBServer");
    objINI.setIntegerProperty("Database", "Port", 1521);
    /* Save changes back to strFile */
    objINI.save();
    objINI = null;
}

Date and Timestamps Usage

Since all data in INI files is stored as strings, the class provides the following methods to interpret the date and timestamp values in the correct manner.

  • setDateFormat - This method allows to set the date format to be used while converting date strings to date data type and vice versa.
  • setTimeFormat - This method allows to set the timestamp format to be used while converting timestamp strings to timestamp data type and vice versa.

For the supported date time formats, please refer to java.text.SimpleDateFormat.

Methods Summary

The class exposes the following public methods to access INI property values. All these methods require that the INI section name and property name be passed as input parameters.

  • getBooleanProperty - Returns boolean value
  • getStringProperty - Returns string value
  • getIntegerProperty - Returns int value
  • getLongProperty - Returns long value
  • getDoubleProperty - Returns double value
  • getDateProperty - Returns java.util.Date value
  • getTimestampProperty - Returns java.sql.Timestamp value

Additionally, the class also provides the following additional methods to retrieve the names of all the sections present in an INI file, names of all the properties present under a particular section, remove the property, remove a section, and save changes back to the disk. The load method is automatically called from the constructor.

  • getAllSectionNames - Returns a string array of section names
  • getAllPropertyNames - Returns a string array of section names. This method requires a section name as an input parameter.
  • removeProperty - Removes specified property from the specified section
  • removeSection - Removes the specified section
  • save - Persist changes back to INI file

I hope this will be useful to anyone who needs this functionality in Java.

Known Limitations

The class does not support property values which span across multiple lines.

Points of Interest

JDK 1.3 and 1.4 do not have built-in classes and/or methods to access environment variable values. Thanks to Mr. Réal Gagnon for generously making the code available to read environment variables.

History

  • 01/07/2004 - Initial release.
  • 07/07/2004 - Added support for environment variables and data type specific getters and setters.
  • 08/07/2004 - Code correction, mostly typing mistakes and a condition in the getStringProperty method.
  • 26/08/2004 - Lots of useful modifications:
    • Added support for section and property level comments.
    • Introduced a separate class to represent a property.
    • Added method to create a named section.
    • Changed HashMap to LinkedHashMap, Sections/Properties now retain their order.
    • Some of the method implementations/signatures are changed.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Prasad Khandekar
Software Developer (Senior) Freelancer
India India
I am a software professional with over 20 years of commercial business applications design and development experience.
 
My programming experience includes Java, Spring, .NET, Classic VB & ASP, Scripting, Power Builder, PHP, Magic & far far ago FoxPro, C, Assembly and COBOL.
 
From last 11 years I am mostly working with Java Technology. I am currently available to take up new assignments.

Comments and Discussions

 
GeneralMy vote of 5 PinmemberAbhijit Thakre7-Apr-13 0:41 
SuggestionException in function save() if using Zero Length Comments PinmemberMember 841312821-Nov-11 0:20 
GeneralWhy it is case-sensitive?! PinmemberDmitry_Bond10-Aug-10 8:54 
GeneralRe: Why it is case-sensitive?! Pinmemberpaul_nicholls31-May-11 19:31 
GeneralRe: Why it is case-sensitive?! Pinmembercharan.kolhe13-Aug-11 8:37 
GeneralMy vote of 2 Pinmemberdvhh2-Mar-09 13:28 
Questionnew function save as can be added as below PinmemberSatish K Patel14-Nov-08 17:59 
GeneralMay I use this code in a commercial product. Pinmemberxsunemp13-Nov-07 3:42 
AnswerRe: May I use this code in a commercial product. PinmemberPrasad Khandekar17-Nov-07 1:58 
GeneralRe: May I use this code in a commercial product. PinmemberMember 48046909-Mar-11 1:19 
GeneralRe: May I use this code in a commercial product. Pinmemberjoewille10-Apr-11 23:53 
QuestionThe class does not compile :( Pinmemberhmoner13-Nov-05 14:22 
AnswerRe: The class does not compile :( PinmemberPrasad Khandekar13-Jan-06 2:29 
GeneralsetSectionComments Pinmemberanarinsky18-Aug-05 13:22 
GeneralRe: setSectionComments PinmemberPrasad Khandekar23-Aug-05 5:04 
GeneralRe: setSectionComments PinmemberVengoal6-Sep-05 18:26 
Generalanother implementation PinsussAnonymous17-Mar-05 20:26 
GeneralSeemingly duplicate ini entries Pinmembercgoudie3-Jan-05 5:05 
GeneralRe: Seemingly duplicate ini entries Pinmemberklizza25-Jan-05 13:14 
Generalnew bug PinmemberDavid Sourek27-Dec-04 11:14 
GeneralRe: new bug Pinmemberlzq1233353-Jun-09 23:23 
GeneralHandling of \n \r and \t PinmemberJens Scheidtmann27-Aug-04 4:56 
GeneralRe: Handling of \n \r and \t PinmemberPrasad Khandekar27-Aug-04 5:37 
GeneralBug fixes and additional improvements PinmemberJohan Natt och Dag13-Aug-04 2:23 
GeneralRe: Bug fixes and additional improvements PinmemberPrasad Khandekar20-Aug-04 2:10 
GeneralRe: Bug fixes and additional improvements PinmemberJohan Natt och Dag20-Aug-04 3:50 
GeneralRe: Bug fixes and additional improvements PinmemberPrasad Khandekar27-Aug-04 5:33 
GeneralRe: Bug fixes and additional improvements Pinmemberklizza27-Aug-04 10:44 
GeneralAnother Bug: NPE Pinmemberklizza23-Aug-04 8:52 
GeneralRe: Bug fixes and additional improvements PinmemberHLO8-Jun-05 6:04 
GeneralRe: Bug fixes and additional improvements PinsussAnonymous8-Jun-05 11:11 
Generalfew bugs in this class Pinsusschcoust11-Jul-04 23:19 
GeneralRe: few bugs in this class PinmemberFayeStar24-Jul-04 1:11 
GeneralRe: few bugs in this class PinmemberMappo3-Aug-04 4:00 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web03 | 2.8.140709.1 | Last Updated 4 Apr 2013
Article Copyright 2004 by Prasad Khandekar
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid