Click here to Skip to main content
12,358,497 members (60,891 online)
Click here to Skip to main content
Add your own
alternative version

Stats

154.3K views
3.1K downloads
35 bookmarked
Posted

An Enhanced INI File Class for Java

, 22 Jun 2015 CPOL
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", "Database SID");
    objINI.setStringProperty("Database", "UserId", "System", "User Id");
    objINI.setStringProperty("Database", "Password", "Manager", "Password");
    objINI.setStringProperty("Database", "HostName", "DBServer", "Server Host");
    objINI.setIntegerProperty("Database", "Port", 1521, "Server Port");
    /* 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. Duplicate properties in a section are not supported. The last property value will overwrite previous value.

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.
  • 15/06/2015 - Now Requires JDK 6 & above. 
    • Section & Property names are now case-insensitive.
    • Duplicate property names are handlled correctly, the last value overwrites the previous.
    • Environment variables are now fetched using System.getEnv()
  • 23/06/2015 - Fixed an issue in commentsnot getting saved properly.

License

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

Share

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.

You may also be interested in...

Comments and Discussions

 
QuestionBug Pin
Member 1007406120-Dec-15 19:35
memberMember 1007406120-Dec-15 19:35 
PraiseRe: Bug Pin
Prasad Khandekar24-Dec-15 1:21
professionalPrasad Khandekar24-Dec-15 1:21 
Generaluseful Pin
Salar Hafezi26-Jun-15 23:15
professionalSalar Hafezi26-Jun-15 23:15 
QuestionsetStringProperty, problems Pin
Jordi Lagares Roset21-Jun-15 3:52
memberJordi Lagares Roset21-Jun-15 3:52 
Bug/KB/java/INIFile/inifilesrc.zip appears to be missing on our servers. D'oh. Pin
Member 1138147616-Jun-15 18:27
memberMember 1138147616-Jun-15 18:27 
GeneralRe: /KB/java/INIFile/inifilesrc.zip appears to be missing on our servers. D'oh. Pin
Prasad Khandekar22-Jun-15 1:58
professionalPrasad Khandekar22-Jun-15 1:58 
GeneralTotal Waste Of Time Pin
Nagy Vilmos15-Jun-15 1:52
professionalNagy Vilmos15-Jun-15 1:52 
GeneralRe: Total Waste Of Time Pin
Prasad Khandekar15-Jun-15 21:12
professionalPrasad Khandekar15-Jun-15 21:12 
Questioninifile.java doesn't work in sdk 4.4.2 ? Pin
Jordi Lagares Roset28-Apr-15 0:38
memberJordi Lagares Roset28-Apr-15 0:38 
AnswerRe: inifile.java doesn't work in sdk 4.4.2 ? Pin
Jordi Lagares Roset30-Apr-15 6:53
memberJordi Lagares Roset30-Apr-15 6:53 
GeneralRe: inifile.java doesn't work in sdk 4.4.2 ? Pin
Prasad Khandekar15-Jun-15 1:43
professionalPrasad Khandekar15-Jun-15 1:43 
GeneralRe: inifile.java doesn't work in sdk 4.4.2 ? Pin
Jordi Lagares Roset16-Jun-15 8:01
memberJordi Lagares Roset16-Jun-15 8:01 
GeneralRe: inifile.java doesn't work in sdk 4.4.2 ? Pin
Prasad Khandekar22-Jun-15 2:03
professionalPrasad Khandekar22-Jun-15 2:03 
GeneralRe: inifile.java doesn't work in sdk 4.4.2 ? Pin
Jordi Lagares Roset22-Jun-15 9:58
memberJordi Lagares Roset22-Jun-15 9:58 
GeneralMy vote of 5 Pin
Abhijit Thakre7-Apr-13 0:41
memberAbhijit Thakre7-Apr-13 0:41 
SuggestionException in function save() if using Zero Length Comments Pin
Member 841312821-Nov-11 0:20
memberMember 841312821-Nov-11 0:20 
GeneralWhy it is case-sensitive?! Pin
Dmitry_Bond10-Aug-10 8:54
memberDmitry_Bond10-Aug-10 8:54 
GeneralRe: Why it is case-sensitive?! Pin
paul_nicholls31-May-11 19:31
memberpaul_nicholls31-May-11 19:31 
GeneralRe: Why it is case-sensitive?! Pin
charan.kolhe13-Aug-11 8:37
membercharan.kolhe13-Aug-11 8:37 
GeneralMy vote of 2 Pin
dvhh2-Mar-09 13:28
memberdvhh2-Mar-09 13:28 
Questionnew function save as can be added as below Pin
Satish K Patel14-Nov-08 17:59
memberSatish K Patel14-Nov-08 17:59 
GeneralMay I use this code in a commercial product. Pin
xsunemp13-Nov-07 3:42
memberxsunemp13-Nov-07 3:42 
AnswerRe: May I use this code in a commercial product. Pin
Prasad Khandekar17-Nov-07 1:58
memberPrasad Khandekar17-Nov-07 1:58 
GeneralRe: May I use this code in a commercial product. Pin
Member 48046909-Mar-11 1:19
memberMember 48046909-Mar-11 1:19 
GeneralRe: May I use this code in a commercial product. Pin
joewille10-Apr-11 23:53
memberjoewille10-Apr-11 23:53 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    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 | Terms of Use | Mobile
Web02 | 2.8.160621.1 | Last Updated 22 Jun 2015
Article Copyright 2004 by Prasad Khandekar
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid