broadwick.io

Class FileInput

java.lang.Object

broadwick.io.FileInput

All Implemented Interfaces:

AutoCloseable

public class FileInput
extends Object
implements AutoCloseable

Simple interface for reading from a file. It simply wraps the java io classes to simplify the input of data.

Field Summary

Fields

Modifier and Type	Field and Description
private static char	COMMENT_CHAR
private static Charset	DEFAULT_ENCODING
private static String	DEFAULT_SEP
private Pattern	fieldSep
private Charset	fileEncoding
private Path	path
protected BufferedReader	reader

Constructor Summary

Constructors

Constructor and Description
FileInput(String dataFileName) Open a handle to a file with the given name.
FileInput(String dataFileName, String sep) Open a handle to a file with the given name.
FileInput(String dataFileName, String sep, Charset encoding) Open a handle to a file with the given name.

Method Summary

Modifier and Type	Method and Description
void	close()
FileInputIterator	iterator() Obtain an iterator for this input file.
String	read() Read the contents of the file into a single string object.
List<String>	readLine() Read a line from the input file, split it according to the seperator specified in the constructor and get a list of tokens from the line.
String	readNextLine() Get the next (non-comment) line from the file.
private List<String>	tokeniseLine(String line) Split a string (a line read from a file into tokens.

Methods inherited from class java.lang.Object

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

Field Detail

path

private Path path

reader

protected BufferedReader reader

fieldSep

private Pattern fieldSep

fileEncoding

private Charset fileEncoding

DEFAULT_SEP

private static final String DEFAULT_SEP

See Also:

Constant Field Values

DEFAULT_ENCODING

private static final Charset DEFAULT_ENCODING

COMMENT_CHAR

private static final char COMMENT_CHAR

See Also:

Constant Field Values

Constructor Detail

FileInput

public FileInput(String dataFileName)
          throws IOException

Open a handle to a file with the given name.

Parameters:

dataFileName - the name of the file.

Throws:

IOException - if the resource can't be found.

FileInput

public FileInput(String dataFileName,
                 String sep)
          throws IOException

Open a handle to a file with the given name.

Parameters:

dataFileName - the name of the file.

sep - The single char for the separator (not a list of separator characters).

Throws:

IOException - if the resource can't be found.

FileInput

public FileInput(String dataFileName,
                 String sep,
                 Charset encoding)
          throws IOException

Open a handle to a file with the given name.

Parameters:

dataFileName - the name of the file.

sep - The single char for the separator (not a list of separator characters).

encoding - the encoding used in the file e.g. UTF-8.

Throws:

IOException - if the resource can't be found.

Method Detail

readLine

public final List<String> readLine()
                            throws IOException

Read a line from the input file, split it according to the seperator specified in the constructor and get a list of tokens from the line. Comment characters (#) are supported, where any character after the comment character is not added to the collection of tokens.

Returns:

a list of entries in the line.

Throws:

IOException - if a line cannot be read, e.g if the object was closed.

readNextLine

public final String readNextLine()
                          throws IOException

Get the next (non-comment) line from the file.

Returns:

a string of the next non-comment line in the file.

Throws:

IOException - if a line cannot be read, e.g if the object was closed.

read

public final String read()
                  throws IOException

Read the contents of the file into a single string object.

Returns:

the contents of the file.

Throws:

IOException - if a line cannot be read, e.g if the object was closed.

tokeniseLine

private List<String> tokeniseLine(String line)

Split a string (a line read from a file into tokens.

Parameters:

line - the line that is to be tokenised.

Returns:

a list of [string] tokens.

close

public final void close()

Specified by:

close in interface AutoCloseable

iterator

public final FileInputIterator iterator()

Obtain an iterator for this input file.

Returns:

the FileInputIterator for this file.