proguard

Class WordReader

java.lang.Object

proguard.WordReader

Direct Known Subclasses:

ArgumentWordReader, LineWordReader

public abstract class WordReader
extends Object

An abstract reader of words, with the possibility to include other readers. Words are separated by spaces or broken off at delimiters. Words containing spaces or delimiters can be quoted with single or double quotes. Comments (everything starting with '#' on a single line) are ignored.

Author:

Eric Lafortune

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WordReader(File baseDir) Creates a new WordReader with the given base directory.
protected	WordReader(URL baseURL) Creates a new WordReader with the given base URL.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the FileWordReader.
File	getBaseDir() Returns the base directory of this reader, if any.
URL	getBaseURL() Returns the base URL of this reader, if any.
void	includeWordReader(WordReader newIncludeWordReader) Specifies to start reading words from the given WordReader.
String	lastComments() Returns the comments collected before returning the last word.
protected abstract String	lineLocationDescription() Returns a readable description of the current WordReader position.
String	locationDescription() Constructs a readable description of the current position in this WordReader and its included WordReader objects.
protected abstract String	nextLine() Reads a line from this WordReader, or from one of its active included WordReader objects.
String	nextWord(boolean isFileName, boolean expectSingleFile) Reads a word from this WordReader, or from one of its active included WordReader objects.
void	setBaseDir(File baseDir) Sets the base directory of this reader.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordReader

protected WordReader(File baseDir)

Creates a new WordReader with the given base directory.

WordReader

protected WordReader(URL baseURL)

Creates a new WordReader with the given base URL.

Method Detail

setBaseDir

public void setBaseDir(File baseDir)

Sets the base directory of this reader.

getBaseDir

public File getBaseDir()

Returns the base directory of this reader, if any.

getBaseURL

public URL getBaseURL()

Returns the base URL of this reader, if any.

includeWordReader

public void includeWordReader(WordReader newIncludeWordReader)

Specifies to start reading words from the given WordReader. When it is exhausted, this WordReader will continue to provide its own words.

Parameters:

newIncludeWordReader - the WordReader that will start reading words.

nextWord

public String nextWord(boolean isFileName,
                       boolean expectSingleFile)
                throws IOException

Reads a word from this WordReader, or from one of its active included WordReader objects.

Parameters:

isFileName - return a complete line (or argument), if the word isn't an option (it doesn't start with '-').

expectSingleFile - if true, the remaining line is expected to be a single file name (excluding path separator), otherwise multiple files might be specified using the path separator.

Returns:

the read word.

Throws:

IOException

lastComments

public String lastComments()
                    throws IOException

Returns the comments collected before returning the last word. Starts collecting new comments.

Returns:

the collected comments, or null if there weren't any.

Throws:

IOException

locationDescription

public String locationDescription()

Constructs a readable description of the current position in this WordReader and its included WordReader objects.

Returns:

the description.

nextLine

protected abstract String nextLine()
                            throws IOException

Reads a line from this WordReader, or from one of its active included WordReader objects.

Returns:

the read line.

Throws:

IOException

lineLocationDescription

protected abstract String lineLocationDescription()

Returns a readable description of the current WordReader position.

Returns:

the description.

close

public void close()
           throws IOException

Closes the FileWordReader.

Throws:

IOException