cs2110

Class TextResourceFile

java.lang.Object

cs2110.TextResourceFile

All Implemented Interfaces:

java.lang.Iterable<java.lang.String>

public class TextResourceFile
extends java.lang.Object
implements java.lang.Iterable<java.lang.String>

Provides an interface to a text resource file. The file should reside in a directory accessible from the classpath. Lines in the file are returned as Strings accessed sequentially through the class's Iterator.

Constructor Summary

Constructors

Constructor and Description
TextResourceFile(java.lang.String filename) Constructs a TextResourceFile object that will take lines sequentially from the text file with the given name relative to the classpath.

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<java.lang.String>	iterator() This implementation does not support Iterator.remove().

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TextResourceFile

public TextResourceFile(java.lang.String filename)

Constructs a TextResourceFile object that will take lines sequentially from the text file with the given name relative to the classpath. If this is going in a .jar file and you are using Windows, use '/' for the name separator character, not File.separatorChar, as '\' doesn't work in .jar files.

Parameters:

filename - the name of the resource file

Throws:

java.util.MissingResourceException - if the resource file is not found or cannot be read

Method Detail

iterator

public java.util.Iterator<java.lang.String> iterator()

This implementation does not support Iterator.remove().

Specified by:

iterator in interface java.lang.Iterable<java.lang.String>

Returns:

an Iterator that returns the lines of the text file sequentially

Throws:

java.lang.IllegalStateException - if the iterator is accessed more than once