com.entrust.toolkit.util

Class IniFile

java.lang.Object

com.entrust.toolkit.util.IniFile

public class IniFile
extends java.lang.Object

IniFile provides a convenient format for storing program data in a file, based closely on MS-Windows 3.x "INI" files. An INI file consists of sections, keys and values. A section consists of related keys and values and all sections and keys must have a unique name.

 eg.
     [Section Name]
     key = value
 

Note: As of 7.1 SP1, the IniFile class has been modified to ensure keys are used in a case-insensitive manner. If for some reason you have an existing application that relies on case sensitive keys, then you can use the following system property to ensure keys are case sensitive.

com.entrust.toolkit.util.IniFile.CaseSensitive=true

You can also set it programmatically by using the System.setProperty() method:

System.setProperty("com.entrust.toolkit.util.IniFile.CaseSensitive","true");

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ENCODING

Constructor Summary

Constructors

Constructor and Description
IniFile() Initializes an empty IniFile
IniFile(java.io.InputStream is) Initializes an IniFile using an InputStream.
IniFile(java.lang.String filename) Initializes an IniFile with a specific filename

Method Summary

Methods

Modifier and Type	Method and Description
int	getInt(java.lang.String sectionName, java.lang.String entryName) Gets the integer value associated with the given key in the given section.
int	getInt(java.lang.String sectionName, java.lang.String entryName, int defaultValue) Gets the integer value associated with the given key in the given section.
java.util.Vector	getSection(java.lang.String sectionName) Gets all of the entries in the given section.
java.util.Enumeration	getSectionNames() Returns an enumeration of all section names in this ini file.
java.lang.String	getString(java.lang.String sectionName, java.lang.String entryName) Gets the value associated with the given entry in the given section.
java.lang.String	getString(java.lang.String sectionName, java.lang.String entryName, java.lang.String defaultString) Gets the value associated with the given entry in the given section.
boolean	putInt(java.lang.String sectionName, java.lang.String entryName, int entryValue) Puts the value associated with the given entry in the given section into the IniFile.
boolean	putSection(java.lang.String sectionName, java.util.List entries) Puts a given set of entries in the given section.
boolean	putString(java.lang.String sectionName, java.lang.String entryName, java.lang.String entryValue) Puts the value associated with the given entry in the given section into the IniFile.
protected void	readIniFile(java.io.BufferedReader reader, java.lang.String charset) Reads the ini file from the given BufferedReader.
void	readStream(java.io.InputStream inputStream) Builds an IniFile object from the given InputStream.
void	readStream(java.io.InputStream inputStream, java.lang.String charset) Builds an IniFile object from the given InputStream.
void	removeEntry(java.lang.String sectionName, java.lang.String entryName) Removes an entry from the IniFile.
void	removeSection(java.lang.String sectionName) Removes a section from the IniFile.
void	writeStream(java.io.OutputStream outputStream) Writes this IniFile object to the given OutputStream.
void	writeStream(java.io.OutputStream outputStream, java.lang.String charset) Writes this IniFile object to the given OutputStream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ENCODING

public static final java.lang.String DEFAULT_ENCODING

See Also:

Constant Field Values

Constructor Detail

IniFile

public IniFile()

Initializes an empty IniFile

IniFile

public IniFile(java.lang.String filename)
        throws java.io.FileNotFoundException

Initializes an IniFile with a specific filename

Parameters:

filename - The name of the file from which the ini file is read.

Throws:

java.io.FileNotFoundException - Thrown if the file for the given filename can't be found.

IniFile

public IniFile(java.io.InputStream is)

Initializes an IniFile using an InputStream.

Parameters:

is - an InputStream from which the ini file is read. The stream is read until there is no more data left, after which the stream is closed.

Method Detail

getString

public java.lang.String getString(java.lang.String sectionName,
                         java.lang.String entryName)

Gets the value associated with the given entry in the given section.

Parameters:

sectionName - The name of the section from which to get the entry.

entryName - The name of the entry in the section.

Returns:

A string containing the value of the entry, or an empty string if the entry is not found.

getString

public java.lang.String getString(java.lang.String sectionName,
                         java.lang.String entryName,
                         java.lang.String defaultString)

Gets the value associated with the given entry in the given section. If no value is found for this key, defaultString is returned.

Parameters:

sectionName - The name of the section from which to get the entry.

entryName - The name of the entry in the section.

defaultString - The value to return if the entry is not found.

Returns:

A string containing the value of the entry, or defaultString if the entry is not found.

getInt

public int getInt(java.lang.String sectionName,
         java.lang.String entryName)

Gets the integer value associated with the given key in the given section. If no value is found for this key, 0 is returned.

Parameters:

sectionName - The name of the section in the IniFile.

entryName - The name of the key in the section.

Returns:

The int value of the entry, or 0 if not found. If there is an exception converting the entry to an integer, 0 is returned.

getInt

public int getInt(java.lang.String sectionName,
         java.lang.String entryName,
         int defaultValue)

Gets the integer value associated with the given key in the given section. If no value is found for this key, defaultValue is returned.

Parameters:

sectionName - The name of the section in the IniFile.

entryName - The name of the key in the section.

defaultValue - The default value to return if the entry cannot be found

Returns:

The int value of the entry, or defaultValue if not found. If there is an exception converting the entry to an integer, defaultValue is returned.

Since:

7.0

getSectionNames

public java.util.Enumeration getSectionNames()

Returns an enumeration of all section names in this ini file.

Returns:

an enumeration of all section names in this ini file.

getSection

public java.util.Vector getSection(java.lang.String sectionName)

Gets all of the entries in the given section. If the given section does not exist, an empty Vector is returned.

This method preserves the order in which entries were added to the section, or were read from an input stream.

Parameters:

sectionName - The name of the section in the IniFile.

Returns:

A Vector containing Strings of entries, (ie. "entryName=value")

putString

public boolean putString(java.lang.String sectionName,
                java.lang.String entryName,
                java.lang.String entryValue)

Puts the value associated with the given entry in the given section into the IniFile. If the entry already exists, its value is updated to the new value.

Parameters:

sectionName - The name of the section to add the entry to.

entryName - The name of the entry in the section.

entryValue - The String value of the entry. Note that the value should not include carriage return or line feed characters. These will cause problems when the file is written and read back in again.

Returns:

true. The return value is maintained for backwards compatibility only.

putInt

public boolean putInt(java.lang.String sectionName,
             java.lang.String entryName,
             int entryValue)

Puts the value associated with the given entry in the given section into the IniFile. If the entry already exists, its value is updated to the new value.

Parameters:

sectionName - The name of the section to add the entry to.

entryName - The name of the entry in the section.

entryValue - The int value of the entry.

Returns:

true. The return value is maintained for backwards compatibility only.

putSection

public boolean putSection(java.lang.String sectionName,
                 java.util.List entries)

Puts a given set of entries in the given section. If the given section name does not exist, a new section of that name is created. If the section does exist, all of the given entries are added to that section.

Parameters:

sectionName - The name of the section in the IniFile.

entries - A List containing strings of entries. e.g. "entryName=value"

Returns:

true. The return value is maintained for backwards compatibility only.

removeEntry

public void removeEntry(java.lang.String sectionName,
               java.lang.String entryName)

Removes an entry from the IniFile. If the entry does not exist, nothing happens.

Parameters:

sectionName - The name of the section from which to remove the entry.

entryName - The name of the entry to remove.

removeSection

public void removeSection(java.lang.String sectionName)

Removes a section from the IniFile. If the section does not exist, nothing happens.

Parameters:

sectionName - The name of the section to remove.

readIniFile

protected void readIniFile(java.io.BufferedReader reader,
               java.lang.String charset)

Reads the ini file from the given BufferedReader.

Parameters:

reader - The BufferedReader from which the ini file is read. Note that this reader is not closed after reading is complete.

charset - The character set that the reader will use to read the data. This is to determine if any special care needs to be taken when reading the stream based on the given character set.

Since:

7.0

readStream

public void readStream(java.io.InputStream inputStream)

Builds an IniFile object from the given InputStream. Any data currently maintained by this object is erased. A default character set of "UTF-8" will be used to write out the INI file.

This method also checks the system property com.entrust.toolkit.util.Initfile.encoding to see if an alternate character coding is specified. If an alternate encoding is specified, that encoding will be used to write the INI file.

Parameters:

inputStream - The stream to read from. The stream is read until there is no more data left to be read, after which the stream is closed.

readStream

public void readStream(java.io.InputStream inputStream,
              java.lang.String charset)

Builds an IniFile object from the given InputStream. Any data currently maintained by this object is erased.

Parameters:

inputStream - The stream to read from. The stream is read until there is no more data left to be read, after which the stream is closed.

charset - The character set to use when reading the Stream. If no character set is specified then the default encoding "UTF-8" will be used.

writeStream

public void writeStream(java.io.OutputStream outputStream)

Writes this IniFile object to the given OutputStream. A default character set of "UTF-8" will be used to write out the INI file.

This method also checks the system property com.entrust.toolkit.util.Initfile.encoding to see if an alternate character coding is specified. If an alternate encoding is specified, that encoding will be used to write the INI file.

Parameters:

outputStream - The OutputStream to which the IniFile will be written. Note that this stream in not closed after the ini file is written.

writeStream

public void writeStream(java.io.OutputStream outputStream,
               java.lang.String charset)

Writes this IniFile object to the given OutputStream.

Parameters:

outputStream - The OutputStream to which the IniFile will be written.

charset - The character set to use when reading the Stream. If no character set is specified then the default encoding "UTF-8" will be used. Note that this stream in not closed after the ini file is written.