org.safs.text

Class INIFileReadWrite

java.lang.Object

org.safs.text.FileLineReader

org.safs.text.INIFileReader

org.safs.text.INIFileReadWrite

public class INIFileReadWrite
extends INIFileReader

Extends INIFileReader to allow modifying INI File values and then writing these values back to a file. We can overwrite the existing INI file or create a different one. We cannot (yet) create and build a new INI file from scratch.

Since:

Feb 23, 2005

Author:

Carl Nagle

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.text.INIFileReader

INIFileReader.JITLoader

Field Summary

Fields inherited from class org.safs.text.INIFileReader

defaultsection, IFR_DEFAULT_MAP_SECTION, IFR_DEFAULT_MAP_SECTION_COMMAND, IFR_MEMORY_MODE_MAPPED, IFR_MEMORY_MODE_STORED, ignoreItemCase, jit, jitstop, memorymode, sections

Fields inherited from class org.safs.text.FileLineReader

charset, DEFAULT_BUFFER_SIZE, eof, file, filename, firstline, fullpath, linetext, reader, stream

Constructor Summary

Constructors

Constructor and Description
INIFileReadWrite()
INIFileReadWrite(java.io.File file, int memorymode)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the JIT and file reader (if still open).
void	finalize()
protected void	saveINIFileWithANSIorUTF8(java.io.File alternate, boolean isUTF8format) Called by writeINIFile(File) and writeUTF8INIFile(File)
void	setAppMapItem(java.lang.String section, java.lang.String item, java.lang.String value) Set/Change a new or existing INI value.
void	writeINIFile(java.io.File alternate) Write the (modified) INI File contents to file.
protected void	writeSection(java.io.BufferedWriter writer, java.lang.String section, CaseInsensitiveHashtable items) Output an INI file [section] to the writer.
void	writeUTF8INIFile(java.io.File alternate) Write the (modified) INI File contents to file formatted with UTF-8.

Methods inherited from class org.safs.text.INIFileReader

clearCache, clearHashtables, closeJIT, getAppMapItem, getDefaultSection, getItem, getItems, getMode, getNewHashtable, getSections, setDefaultSection, tryJITLoader

Methods inherited from class org.safs.text.FileLineReader

closeReader, getFilename, getFullpath, isClosed, isEOF, open, openFile, openStream, readLine, resetpointers, setFile, setStream

Methods inherited from class java.lang.Object

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

Constructor Detail

INIFileReadWrite

public INIFileReadWrite()

See Also:

INIFileReader.INIFileReader()

INIFileReadWrite

public INIFileReadWrite(java.io.File file,
                        int memorymode)

See Also:

INIFileReader.INIFileReader(File, int)

Method Detail

setAppMapItem

public void setAppMapItem(java.lang.String section,
                          java.lang.String item,
                          java.lang.String value)

Set/Change a new or existing INI value. The routine will add a new section or item as necessary. Note: these changes will not persist past a call to clearCache unless a writeINIFile call is performed first.

Parameters:

section - section to receive value. If null or 0-length the item will be stored in the first unnamed section. The section names are not case-sensitive.

item - to receive the specified value. null or 0-length item names will be ignored and the routine will return without error. The item names are not case-sensitive.

value - of the item. null values will be ignored and the routine will return without error. 0-length values (empty strings) are allowed. Note: values are not automatically wrapped in single or double quotes. So if the value as written to file should contain quotes they need to already be part of the value provided.

See Also:

writeINIFile(File), INIFileReader.clearCache()

writeINIFile

public void writeINIFile(java.io.File alternate)

Write the (modified) INI File contents to file. Closes our File if it is open and then opens to write the new file. We can write a new INI file or overwrite the existing INI file if an alternate File object is provided.

Parameters:

alternate - optional File object to write the information to a File other than the one originally read in. A null value will result in writing back (overwriting) the same file we read in.

writeUTF8INIFile

public void writeUTF8INIFile(java.io.File alternate)

Write the (modified) INI File contents to file formatted with UTF-8.

See Also:

writeINIFile(File)

saveINIFileWithANSIorUTF8

protected void saveINIFileWithANSIorUTF8(java.io.File alternate,
                                         boolean isUTF8format)

Called by writeINIFile(File) and writeUTF8INIFile(File)

Parameters:

alternate - alternate optional File object.

isUTF8format - true, write file with UTF8 format; false, write file with ANSI format.

See Also:

#writeUTF8INIFile(File)

writeSection

protected void writeSection(java.io.BufferedWriter writer,
                            java.lang.String section,
                            CaseInsensitiveHashtable items)

Output an INI file [section] to the writer. If 'section' is null or 0-length then we are writing to an unnamed (unbracketed) section. Each item in the items Hashtable is written as a name=value pair on a separate line. A single blank line is written at the end of the section to separate sections.

close

public void close()

Closes the JIT and file reader (if still open). This is not necessarily an object termination event because we may just be writing our INI file data back to a file and then resuming normal operation.

Overrides:

close in class INIFileReader

See Also:

INIFileReader.closeJIT(), FileLineReader.closeReader()

finalize

public void finalize()
              throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable