ioutil
Class LineSource

java.lang.Object
  |
  +--ioutil.LineSource

Direct Known Subclasses:

BatchLineSource, InteractiveLineSource

public abstract class LineSource

extends java.lang.Object

implements ILineSource

Class LineSource implements the ILineSource methods for its subclasses. Subclasses may reimplement these methods as needed.

Constructor Summary

LineSource()

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.
LineSource	getIncludedFrom() src.getIncludedFrom() returns the LineSource that src is included from, or null if there is no such LineSource.
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.
void	setIncludedFrom(LineSource from) src.setIncludedFrom(from) sets the includedFrom link for src to from.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineSource

public LineSource()

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.

Specified by:

more in interface ILineSource

current

public LineScanner current()
                    throws java.io.IOException,
                           java.lang.IllegalArgumentException

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

Precondition: src.more() is true.

Specified by:

current in interface ILineSource

advance

public void advance()
             throws java.io.IOException,
                    java.lang.IllegalArgumentException

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

Precondition: src.more() is true.

Specified by:

advance in interface ILineSource

getLineNumber

public int getLineNumber()

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

Specified by:

getLineNumber in interface ILineSource

getFileName

public java.lang.String getFileName()

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

Specified by:

getFileName in interface ILineSource

setEchoOn

public void setEchoOn()

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

Specified by:

setEchoOn in interface ILineSource

setEchoOff

public void setEchoOff()

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

Specified by:

setEchoOff in interface ILineSource

getIncludedFrom

public LineSource getIncludedFrom()

src.getIncludedFrom() returns the LineSource that src is included from, or null if there is no such LineSource.

setIncludedFrom

public void setIncludedFrom(LineSource from)

src.setIncludedFrom(from) sets the includedFrom link for src to from.