net.pandoragames.util.file

Class ListFile

java.lang.Object

net.pandoragames.util.file.ListFile

Direct Known Subclasses:

ObjectListFile

public class ListFile
extends java.lang.Object

Reads and writes lists of Strings from and to files. This utility class spares the construction of streams and readers to handle lists stored in files. Respective files are generally UTF-8 encoded. Each string will be read from (written to) a line of its own. However, strings with line break may still be stored as they will be escaped with "\n".

Whitespace at both ends of the strings will be striped when reading and writing. An empty string will be stored as a single "\" backslash character, while null values will generally be ignored when writing.

A line that starts with a "#" hash character is considered a comment. Comment lines are ignored when reading, but you may include them in the file by adding them to the list.

Author:

Olivier Wehner at 29.03.2008

Constructor Summary

Constructors

Constructor and Description
ListFile(java.io.File file)

Method Summary

Methods

Modifier and Type	Method and Description
java.io.File	getFile() Returns the file this class was instantiated with.
java.util.List<java.lang.String>	load() Loads the list from the file specified with the constructor.
void	store(java.util.List<java.lang.String> list) Stores the specified list in the file supplied with the constructor.
void	store(java.util.List<java.lang.String> list, boolean append) Stores the specified list in the file supplied with the constructor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListFile

public ListFile(java.io.File file)

Method Detail

getFile

public java.io.File getFile()

Returns the file this class was instantiated with.

Returns:

underlying file object.

load

public java.util.List<java.lang.String> load()
                                      throws java.io.IOException

Loads the list from the file specified with the constructor. Creates the file if it does not exitst. See class comment for further details.

Returns:

list loaded from file

Throws:

java.io.IOException - if the list could not be written for any reason

store

public void store(java.util.List<java.lang.String> list)
           throws java.io.IOException

Stores the specified list in the file supplied with the constructor. Creates the file if it does not exist, rewrites it if does exist. Thus this method is equivalent to calling store( list, false ). See class comment for further details.

Parameters:

list - to be saved to the file system

Throws:

java.io.IOException

store

public void store(java.util.List<java.lang.String> list,
         boolean append)
           throws java.io.IOException

Stores the specified list in the file supplied with the constructor. Creates the file if it does not exist. See class comment for further details.

Parameters:

list - to be saved to the file system

append - set to true to append to the specified file

Throws:

java.io.IOException