A B C D E F G H I L M N O P Q R S T W

A

add(Command) - Method in class ioutil.CommandTable

ct.add(comm) adds comm to ct.

addCommands() - Method in class ioutil.Tester

addCommands() adds testing commands to the command table.

addCommands() - Method in class ioutil.FormattingTester

addCommands() adds testing commands to the command table.

addCommands() - Method in class ioutil.CircularListTester

addCommands() adds testing commands to the command table.

addError(String) - Method in class ioutil.LineScanner

ls.addError(msg) adds msg to the error list for ls.

addFirst(Object) - Method in class ioutil.CircularList

cl.addFirst(dat) adds dat as the first data item in cl.

addLast(Object) - Method in class ioutil.CircularList

cl.addLast(dat) adds dat as the last data item in cl.

advance() - Method in class ioutil.LineSource

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

advance() - Method in class ioutil.LineScanner

ls.advance() advances the current position in ls.

advance() - Method in interface ioutil.ILineSource

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

advance() - Method in class ioutil.LineStream

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

append(CircularList) - Method in class ioutil.CircularList

cl.append(cl1) appends cl1 onto the end of cl and makes cl1 empty.

atChar() - Method in class ioutil.LineScanner

ls.atChar() returns true if the token at the current position of ls is a character.

atEnd() - Method in class ioutil.LineScanner

ls.atEnd() returns true if the current position of ls is at the end of the line.

atFloat() - Method in class ioutil.LineScanner

ls.atFloat() returns true if the token at the current position of ls is a float.

atInt() - Method in class ioutil.LineScanner

ls.atInt() returns true if the token at the current position of ls is an int.

atString() - Method in class ioutil.LineScanner

ls.atString() returns true if the token at the current position of ls is a string.

B

BatchLineSource - class ioutil.BatchLineSource.

A BatchLineSource dispenses LineScanners for lines of a disk file.

BatchLineSource(String) - Constructor for class ioutil.BatchLineSource

BatchLineSource(fName) returns a LineSource that dispenses LineScanners for lines of the file named fName.

binary(long, int) - Static method in class ioutil.Formatting

Formatting.binary(n, w) returns the unsigned binary representation of n, right justified in a string field of width at least w.

binary(long, int, char) - Static method in class ioutil.Formatting

Formatting.binary(n, w, fc) returns the unsigned binary representation of n, right justified in a string field of width at least w.

briefDescription(int) - Method in class ioutil.Command

comm.briefDescription(nameWidth) returns the brief description string for comm.

briefHelp() - Method in class ioutil.Command

comm.briefHelp() returns the brief help string for comm.

C

CircularList - class ioutil.CircularList.

A CircularList is a list with its far end linked to its near end.

CircularList.Node - class ioutil.CircularList.Node.

A Node is a building block for circular linked lists.

CircularList.Node(CircularList) - Constructor for class ioutil.CircularList.Node

Node() returns a Node with null data and next.

CircularList.Node(CircularList, Object) - Constructor for class ioutil.CircularList.Node

Node(dat) returns a Node with data dat and null next.

CircularList.Node(CircularList, Object, CircularList.Node) - Constructor for class ioutil.CircularList.Node

Node(dat, l) returns a Node with data dat and next l.

CircularList() - Constructor for class ioutil.CircularList

CircularList() returns an empty CircularList.

CircularList(Object) - Constructor for class ioutil.CircularList

CircularList(dat) returns a CircularList with a single data item dat.

CircularListTester - class ioutil.CircularListTester.

This class provides a main() method for testing the CircularList class.

CircularListTester() - Constructor for class ioutil.CircularListTester

Command - class ioutil.Command.

The Command class is the parent class for subclasses whose instances are commands that can be stored in a CommandTable for execution in a command interpreter program.

Command() - Constructor for class ioutil.Command

new Command() returns a command whose name is "#", whose argument string is an empty string, and whose brief and full descriptions are "line is a comment"

commandName() - Method in class ioutil.Command

comm.commandName() returns the command name string for comm.

CommandTable - class ioutil.CommandTable.

A CommandTable provides a means for storing, retrieving, and executing commands for command-driven interpreter programs.

CommandTable() - Constructor for class ioutil.CommandTable

new CommandTable() returns a new empty CommandTable.

CommandTableTest - class ioutil.CommandTableTest.

Class CommandTableTest provides a main function for testing the CommandTable class.

CommandTableTest() - Constructor for class ioutil.CommandTableTest

current() - Method in class ioutil.LineSource

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

current() - Method in class ioutil.InteractiveLineSource

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

current() - Method in interface ioutil.ILineSource

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

current() - Method in class ioutil.LineStream

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

currentChar() - Method in class ioutil.LineScanner

ls.currentChar() returns the string value of the current token of ls.

currentFloat() - Method in class ioutil.LineScanner

ls.currentFloat() returns the float value of the current token of ls.

currentInt() - Method in class ioutil.LineScanner

ls.currentInt() returns the int value of the current token of ls.

currentString() - Method in class ioutil.LineScanner

ls.currentString() returns the string value of the current token of ls.

D

data - Variable in class ioutil.CircularList.Node

l.data is the data for l.

decimal(long, int) - Static method in class ioutil.Formatting

Formatting.decimal(n, w) returns the decimal representation of n, right justified in a string field of width at least w.

decimal(long, int, char) - Static method in class ioutil.Formatting

Formatting.decimal(n, w, fc) returns the decimal representation of n, right justified in a string field of width at least w.

displayHelp(String) - Method in class ioutil.CommandTable

ct.displayHelp(String str) displays full descriptions for Commands in ct whose name matches str.

displayMenu() - Method in class ioutil.CommandTable

ct.displayMenu() displays a menu of commands in ct.

doCommands() - Method in class ioutil.Tester

doCommands() executes commands from the command stream.

doNothingCommand(String) - Static method in class ioutil.CommandTable

CommandTable.doNothingCommand(str) returns a Command that does nothing.

E

ECHO - Static variable in class ioutil.LineScanner

endInsert() - Method in class ioutil.LineStream

strm.endInsert() terminates an insert begun by insertInteractiveLines() or insertBatchLines().

endInsertCommand(String) - Method in class ioutil.LineStream

strm.endInsertCommand(nm) returns a Command whose name is nm.

errorCount() - Method in class ioutil.LineScanner

ls.errorCount() returns the number of error messages in ls.

execute(LineScanner) - Method in class ioutil.CommandTable

ct.execute(commLine) executes the Command whose name is the first word of commLine and whose arguments are the remaining words of commLine.

execute(LineScanner) - Method in class ioutil.Command

comm.execute(args) executes the command comm with arguments read from args.

F

filledLeft(String, int) - Static method in class ioutil.Formatting

Formatting.filledLeft(str, w) returns a copy of the string str, right justified in a string field of width at least w.

filledLeft(String, int, char) - Static method in class ioutil.Formatting

Formatting.filledLeft(str, w, fc) returns a copy of the string str, right justified in a string field of width at least w.

filledRight(String, int) - Static method in class ioutil.Formatting

Formatting.filledRight(str, w) returns a copy of the string str, right justified in a string field of width at least w.

filledRight(String, int, char) - Static method in class ioutil.Formatting

Formatting.filledRight(str, w, fc) returns a copy of the string str, left justified in a string field of width at least w.

fillString(int) - Static method in class ioutil.Formatting

Formatting.fillString(w) returns a string of length w whose characters are all spaces.

fillString(int, char) - Static method in class ioutil.Formatting

Formatting.fillString(w, fc) returns a string of length w whose characters are all copies of fc.

Formatting - class ioutil.Formatting.

The Formatting class provides utility methods for formatting text for String and numerical data.

Formatting() - Constructor for class ioutil.Formatting

FormattingTester - class ioutil.FormattingTester.

This class provides a main() method for testing the Formatting class.

FormattingTester() - Constructor for class ioutil.FormattingTester

fullDescription() - Method in class ioutil.Command

comm.fullDescription() returns the full description string for comm.

fullHelp() - Method in class ioutil.Command

comm.fullHelp() returns the full help string for comm.

G

getEchoPolicy() - Method in class ioutil.LineScanner

ls.getEchoPolicy(echoPol) returns the echo policy of ls.

getFileName() - Method in class ioutil.LineSource

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

getFileName() - Method in interface ioutil.ILineSource

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

getFileName() - Method in class ioutil.LineStream

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

getFirst() - Method in class ioutil.CircularList

cl.getFirst() returns the first data item in cl.

getIncludedFrom() - Method in class ioutil.LineSource

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

getLast() - Method in class ioutil.CircularList

cl.getLast() returns the last data item in cl.

getLineNumber() - Method in class ioutil.LineSource

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

getLineNumber() - Method in interface ioutil.ILineSource

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

getLineNumber() - Method in class ioutil.LineStream

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

getText() - Method in class ioutil.LineScanner

ls.getText(echoPol) returns the text of ls.

H

helpCommand(String) - Method in class ioutil.CommandTable

ct.helpCommand(str) returns a Command named str.

hexadecimal(long, int) - Static method in class ioutil.Formatting

Formatting.hexadecimal(n, w) returns the unsigned hexadecimal representation of n, right justified in a string field of width at least w.

hexadecimal(long, int, char) - Static method in class ioutil.Formatting

Formatting.hexadecimal(n, w, fc) returns the unsigned hexadecimal representation of n, right justified in a string field of width at least w.

I

ILineSource - interface ioutil.ILineSource.

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

insertBatchLines(String) - Method in class ioutil.LineStream

strm.insertBatchLines(fn) inserts lines read from the file named by fn into the stream of lines read by strm.

insertInteractiveLines(String) - Method in class ioutil.LineStream

strm.insertInteractiveLines(prmt) inserts lines read from the terminal into the stream of lines read by strm.

insertLinesCommand(String) - Method in class ioutil.LineStream

strm.insertLinesCommand(nm) returns a Command whose name is nm.

InteractiveLineSource - class ioutil.InteractiveLineSource.

An InteractiveLineSource dispenses LineScanners for lines read from the terminal.

ioutil - package ioutil

isEmpty() - Method in class ioutil.CircularList

cl.isEmpty() returns true if cl is empty.

L

LineScanner - class ioutil.LineScanner.

An object of class LineScanner scans text, breaking it up into tokens.

LineScanner(String, int) - Constructor for class ioutil.LineScanner

new LineScanner(str, echoPol) returns a new LineScanner for scanning str.

LineScanner(String, int, int) - Constructor for class ioutil.LineScanner

new LineScanner(str, echoPol, skip) returns a new LineScanner for scanning str.

LineScannerTest - class ioutil.LineScannerTest.

Class LineScannerTest provides a main function for testing the LineScanner class.

LineScannerTest() - Constructor for class ioutil.LineScannerTest

LineSource - class ioutil.LineSource.

Class LineSource implements the ILineSource methods for its subclasses.

LineSource() - Constructor for class ioutil.LineSource

LineStream - class ioutil.LineStream.

A LineStream dispenses LineScanners for lines read from ILineSources organized as a stack.

LineStream() - Constructor for class ioutil.LineStream

LineStream() returns an empty LineStream.

LineStream(LineSource) - Constructor for class ioutil.LineStream

LineStream(src) returns a LineStream that begins reading from src.

LineStream(String) - Constructor for class ioutil.LineStream

LineStream(prmt) returns a LineStream that begins reading from the terminal using prmt for prompting.

LineStreamTest - class ioutil.LineStreamTest.

Class LineStreamTest provides a main function for testing the LineStream class.

LineStreamTest() - Constructor for class ioutil.LineStreamTest

M

main(String[]) - Static method in class ioutil.LineStreamTest

main(args) tests the LineStream class.

main(String[]) - Static method in class ioutil.CommandTableTest

main(argv) tests the CommandTable class.

main(String[]) - Static method in class ioutil.LineScannerTest

main(argv) tests the LineScanner class.

main(String[]) - Static method in class ioutil.Tester

If this program is executed with no command line argument then it executes commands entered from the terminal.

main(String[]) - Static method in class ioutil.FormattingTester

If this program is executed with no command line argument then it executes commands entered from the terminal.

main(String[]) - Static method in class ioutil.CircularListTester

If this program is executed with no command line argument then it executes commands entered from the terminal.

more() - Method in class ioutil.LineSource

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

more() - Method in interface ioutil.ILineSource

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

more() - Method in class ioutil.LineStream

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

N

nameLength() - Method in class ioutil.Command

comm.nameLength() returns the length of the command name string for comm.

next - Variable in class ioutil.CircularList.Node

l.next is a reference to the next Node from l.

NO_ECHO - Static variable in class ioutil.LineScanner

O

octal(long, int) - Static method in class ioutil.Formatting

Formatting.octal(n, w) returns the unsigned octal representation of n, right justified in a string field of width at least w.

octal(long, int, char) - Static method in class ioutil.Formatting

Formatting.octal(n, w, fc) returns the unsigned octal representation of n, right justified in a string field of width at least w.

openStream(String[]) - Method in class ioutil.Tester

openStream(args) checks the command line for a correct number of arguments and opens a source file if specified.

P

printAllErrors() - Method in class ioutil.LineScanner

ls.printAllErrors() prints all of the error messages in ls to System.out.

printFirstError() - Method in class ioutil.LineScanner

ls.printFirstError() prints the first error message in ls to System.out, if there is one.

Q

quitCommand(String) - Static method in class ioutil.CommandTable

CommandTable.quitCommand(str) returns a Command that terminates the program.

R

readChar() - Method in class ioutil.LineScanner

ls.readChar() returns the character value of the current token of ls, then advances the current position.

readEnd() - Method in class ioutil.LineScanner

ls.readEnd() records an error message in ls if the current position of ls is not at the end of the line.

readFloat() - Method in class ioutil.LineScanner

ls.readFloat() returns the float value of the current token of ls, then advances the current position.

readInt() - Method in class ioutil.LineScanner

ls.readInt() returns the int value of the current token of ls, then advances the current position.

readString() - Method in class ioutil.LineScanner

ls.readString() returns the string value of the current token of ls, then advances the current position.

removeFirst() - Method in class ioutil.CircularList

cl.removeFirst() removes the first data item from cl.

removeLastError() - Method in class ioutil.LineScanner

ls.removeLastError() removes the last error message from ls.

rotate() - Method in class ioutil.CircularList

cl.rotate() rotates the first data item in cl to the end of cl.

S

setEchoOff() - Method in class ioutil.LineSource

src.setEchoOff() turns echoing off for src if src supports echo control.

setEchoOff() - Method in interface ioutil.ILineSource

src.setEchoOff() turns echoing off for src if src supports echo control.

setEchoOff() - Method in class ioutil.LineStream

src.setEchoOff() turns echoing off for the top LineSource in src.

setEchoOffCommand(String) - Method in class ioutil.LineStream

strm.setEchoOffCommand(nm) returns a Command whose name is nm.

setEchoOn() - Method in class ioutil.LineSource

src.setEchoOn() turns echoing on for src if src supports echo control.

setEchoOn() - Method in interface ioutil.ILineSource

src.setEchoOn() turns echoing on for src if src supports echo control.

setEchoOn() - Method in class ioutil.LineStream

src.setEchoOn() turns echoing on for the top LineSource in src.

setEchoOnCommand(String) - Method in class ioutil.LineStream

strm.setEchoOnCommand(nm) returns a Command whose name is nm.

setEchoPolicy(int) - Method in class ioutil.LineScanner

ls.setEchoPolicy(echoPol) changes the echo policy of ls to echoPol.

setIncludedFrom(LineSource) - Method in class ioutil.LineSource

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

setText(String) - Method in class ioutil.LineScanner

ls.setText(str) resets ls in preparation for scanning str.

setText(String, int) - Method in class ioutil.LineScanner

ls.setText(str, skip) resets ls in preparation for scanning str.

startInteractive() - Method in class ioutil.Tester

startInteractive() prints messages to the interactive user describing how to use the program.

synopsis() - Method in class ioutil.Command

comm.synopsis() returns the synopsis string for comm.

synopsisLength() - Method in class ioutil.Command

comm.synopsisLength() returns the length of the synopsis string for comm.

T

test(String) - Static method in class ioutil.LineScannerTest

test(str) tests the LineScanner class on str.

Tester - class ioutil.Tester.

Class Tester is a base class for line-oriented, command-driven, interactive and batch testing.

Tester() - Constructor for class ioutil.Tester

Tester() returns a new Tester.

toString() - Method in class ioutil.CircularList

cl.toString() returns a string describing the data in cl.

trimmedLeft(String, int) - Static method in class ioutil.Formatting

Formatting.trimmedLeft(str, w) returns a copy of the string str, trimmed on the left if necessary to fit in a string field of width w.

trimmedRight(String, int) - Static method in class ioutil.Formatting

Formatting.trimmedRight(str, w) returns a copy of the string str, trimmed on the right if necessary to fit in a string field of width w.

W

whiteEquivalent(String) - Static method in class ioutil.Formatting

Formatting.whiteEquivalent(str) returns a string that displays in the same space as str, but contains space characters replacing the non-white characters of str.

whiteEquivalent(String, char) - Static method in class ioutil.Formatting

Formatting.whiteEquivalent(str, ch) returns a string that displays in the same space as str, but contains copies of ch replacing the non-white characters of str.

A B C D E F G H I L M N O P Q R S T W