gshute.ioutil
Interface ILineSource

All Known Implementing Classes:

LineSource, LineStream

public abstract interface ILineSource

ILineSource is the interface for classes that can dispense LineScanners for lines read from an input stream.

Method Summary

void	advance() src.advance() advances the input position of src to the next line.
LineScanner	current() src.current() returns the line at the current position of src.
java.lang.String	getFileName() src.getFileName() Returns the name of the file from which src reads lines.
int	getLineNumber() src.getLineNumber() returns the line number of the current line in src.
boolean	more() src.more() returns true if there is a line at the current input position of src, false if not.
void	setEchoOff() src.setEchoOff() turns echoing off for src if src supports echo control.
void	setEchoOn() src.setEchoOn() turns echoing on for src if src supports echo control.

Method Detail

more

public boolean more()
             throws java.io.IOException

src.more() returns true if there is a line at the current input position of src, false if not.

current

public LineScanner current()
                    throws java.io.IOException

src.current() returns the line at the current position of src.

Precondition: src.more() is true.

advance

public void advance()
             throws java.io.IOException

src.advance() advances the input position of src to the next line.

Precondition: src.more() is true.

getLineNumber

public int getLineNumber()

src.getLineNumber() returns the line number of the current line in src.

getFileName

public java.lang.String getFileName()

src.getFileName() Returns the name of the file from which src reads lines.

setEchoOn

public void setEchoOn()

src.setEchoOn() turns echoing on for src if src supports echo control. If not, then setEchoOn has no effect.

setEchoOff

public void setEchoOff()

src.setEchoOff() turns echoing off for src if src supports echo control. If not, then setEchoOff has no effect.