org.arp.javautil.test

Class ExpectedSetOfStringsReader

java.lang.Object

org.arp.javautil.test.ExpectedSetOfStringsReader

public final class ExpectedSetOfStringsReader
extends Object

Reads a file of strings, one per line, into a Set. Optionally, it allows specifying a comment character. On lines that contain the specified character, the character and the remainder of the line are ignored.

Author:

Andrew Post

Constructor Summary

Constructors

Constructor and Description
ExpectedSetOfStringsReader()

Method Summary

Modifier and Type	Method and Description
Set<String>	readAsSet(String resource, Class<?> cls) Reads the file with the specifies resource name, calling Class.getResourceAsStream(java.lang.String) to access the file.
Set<String>	readAsSet(String resource, Class<?> cls, Character commentCharacter) Reads the file with the specifies resource name, calling Class.getResourceAsStream(java.lang.String) to access the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpectedSetOfStringsReader

public ExpectedSetOfStringsReader()

Method Detail

readAsSet

public Set<String> readAsSet(String resource,
                             Class<?> cls)
                      throws IOException

Reads the file with the specifies resource name, calling Class.getResourceAsStream(java.lang.String) to access the file.

Parameters:

resource - the name of the file resource. Cannot be null.

cls - the class to use. If null, the instance of this class will be used.

Returns:

a Set of strings, guaranteed not null.

Throws:

IOException - if an error occurs reading the file.

readAsSet

public Set<String> readAsSet(String resource,
                             Class<?> cls,
                             Character commentCharacter)
                      throws IOException

Reads the file with the specifies resource name, calling Class.getResourceAsStream(java.lang.String) to access the file.

Parameters:

resource - the name of the file resource. Cannot be null.

cls - the class to use. If null, the instance of this class will be used.

commentCharacter - the comment character to use. Set to null if nothing should be interpreted as a comment.

Returns:

a Set of strings, guaranteed not null.

Throws:

IOException - if an error occurs reading the file.