Utils
Class CommentedFileReader

java.lang.Object
  extended by Utils.CommentedFileReader

public class CommentedFileReader
extends java.lang.Object

Reads from a commented file ignoring any comments

Version:
1.0

Constructor Summary
CommentedFileReader(java.io.File f)
          Constructor
 
Method Summary
 void close()
          Close the file reader
 java.lang.String readLine()
          Reads a line from the file
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommentedFileReader

public CommentedFileReader(java.io.File f)
                    throws java.io.FileNotFoundException
Constructor

Parameters:
f - The file to read from
Throws:
java.io.FileNotFoundException - thrown if the file is not found
Method Detail

readLine

public java.lang.String readLine()
                          throws java.io.IOException
Reads a line from the file

Returns:
The next line in the file that isn't completely commented out and with all comments stripped.
Throws:
java.io.IOException - thrown if the underlying BufferedReader throws this exception

close

public void close()
           throws java.io.IOException
Close the file reader

Throws:
java.io.IOException - thrown if the underlying BuffereReader throws this exception when it is closed.