StreamParser (boone)

java.lang.Object
- boone.util.StreamParser

```
public class StreamParser
extends java.lang.Object
```
Parse a stream, character by character. Provides read methods for various data types and read styles.
The principle here is that the various read methods change the state of this parser object. For example, the readWord() method does not return a value, but sets the value of the workBuffer attribute instead.

Version:

$Id$

Author:

August Mayer

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`commentStart` a line comment indicator: rest of the line after this is to be ignored.
`char`	`curChar` the current character that was read from the stream.
`char`	`firstCommentChar` the first character of the `commentStart` string.
`protected java.lang.Exception`	`readException` the last exception while reading
`int`	`readState` the current read state.
`java.io.BufferedInputStream`	`stream` the input stream from which to read
`java.lang.StringBuffer`	`workBuffer` a working buffer, used by the readXYZ functions to return the thing that was read

Constructor Summary

Constructors
Constructor and Description

StreamParser(java.io.InputStream stream)
Constructs the parser with the given stream.

Constructors
Constructor and Description
`StreamParser(java.io.InputStream stream)` Constructs the parser with the given stream.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`expect(java.lang.String str)` expect some string.
`java.lang.Exception`	`getReadException()` return the last read exception and clear it.
`void`	`nextChar()` read the next character from the stream.
`double`	`readFloatNumber()` Parse a floating-point number.
`int`	`readIntNumber()` Parse an integer number.
`void`	`readLine()` Read until the end of the line.
`void`	`readSpace()` Everything `<= 32` is considered whitespace.
`void`	`readSpaceOnly()` Everything `<= 32` is considered whitespace; this method reads over it.
`void`	`readUntil(char ch)` read until the given character occurs.
`boolean`	`readUntilCharOrNewline(char ch)` Read until the given character occurs, or until a Newline (LF, '\n') occurs.
`void`	`readWord()` Read a word, until the next whitespace.
`void`	`trimEnd(java.lang.StringBuffer buf)` remove whitespace from the end of the given StringBuffer

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - stream
```
public java.io.BufferedInputStream stream
```
    the input stream from which to read
  - readException
```
protected java.lang.Exception readException
```
    the last exception while reading
  - readState
```
public int readState
```
    the current read state. >= 0 is ok, -1 is EOF and -2 is error.
  - curChar
```
public char curChar
```
    the current character that was read from the stream.
  - workBuffer
```
public java.lang.StringBuffer workBuffer
```
    a working buffer, used by the readXYZ functions to return the thing that was read
  - commentStart
```
public java.lang.String commentStart
```
    a line comment indicator: rest of the line after this is to be ignored. Please also set firstCommentChar if you change this. By default, line comments start with "#".
  - firstCommentChar
```
public char firstCommentChar
```
    the first character of the commentStart string.
- Constructor Detail
  - StreamParser
```
public StreamParser(java.io.InputStream stream)
```
    Constructs the parser with the given stream. Also reads the first character from the stream.
    
    Parameters:
    
    stream - an input stream
- Method Detail
  - nextChar
```
public void nextChar()
```
    read the next character from the stream. Get the current character using the curChar variable. Error information is stored in the readState variable; -1 for End Of File, -2 for Exception, which is also stored in the readException variable, or a code >= 0 for OK.
  - getReadException
```
public java.lang.Exception getReadException()
```
    return the last read exception and clear it.
  - trimEnd
```
public void trimEnd(java.lang.StringBuffer buf)
```
    remove whitespace from the end of the given StringBuffer
  - readSpaceOnly
```
public void readSpaceOnly()
```
    Everything <= 32 is considered whitespace; this method reads over it. Doesn't read over comments (contrary to former readSpace behaviour). Uses nextChar(). Note that this function does not change the work buffer.
  - readSpace
```
public void readSpace()
```
    Everything <= 32 is considered whitespace. Also reads over comments that start with commentStart and go until the end of the line. Uses nextChar(). Note that this function does not change the work buffer.
  - expect
```
public boolean expect(java.lang.String str)
```
    expect some string.
    
    Returns:
    
    true iff the string did occur exactly as expected
  - readWord
```
public void readWord()
```
    Read a word, until the next whitespace. If the current character is a whitespace, do nothing, and clear the workBuffer. The word that was read is put into the workBuffer.
  - readLine
```
public void readLine()
```
    Read until the end of the line. A line terminates with a LF '\n' (but CRs '\r' are thrown away). Eats the '\n'. Puts the rest of the current line into the workBuffer, without the '\n', and without '\r's. Also, skips over a '\r' that follows the terminating '\n'.
  - readUntil
```
public void readUntil(char ch)
```
    read until the given character occurs. The character is not consumed, i.e. it is not added to the workBuffer, but stays in the curChar variable.
  - readUntilCharOrNewline
```
public boolean readUntilCharOrNewline(char ch)
```
    Read until the given character occurs, or until a Newline (LF, '\n') occurs. The character is not consumed, i.e. it is not added to the workBuffer, but stays in the curChar variable. Throws away all CRs '\r'.
    NOTE: This doesn't do exactly the same thing as readLine() - The curChar pointer remains at the final character (the given char, or NL). readLine, on the other hand, also eats the NL and possibly a following CR.
    
    Parameters:
    
    ch - The Char to read until.
    
    Returns:
    
    true, if the char was found; false, if a newline was encountered.
  - readIntNumber
```
public int readIntNumber()
```
    Parse an integer number. Accept all characters in "0123456789-", Put the parsed number string into workBuffer, and also returns it.
    
    Returns:
    
    The parsed number, as an int.
    
    Throws:
    
    java.lang.NumberFormatException - if the parsed number is not a valid integer.
  - readFloatNumber
```
public double readFloatNumber()
```
    Parse a floating-point number. Accept all characters in "0123456789-.Ee", Put the parsed number string into workBuffer.
    
    Returns:
    
    The parsed number, as a double.
    
    Throws:
    
    java.lang.NumberFormatException - if the parsed number is not a valid double.

Class StreamParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

stream

readException

readState

curChar

workBuffer

commentStart

firstCommentChar

Constructor Detail

StreamParser

Method Detail

nextChar

getReadException

trimEnd

readSpaceOnly

readSpace

expect

readWord

readLine

readUntil

readUntilCharOrNewline

readIntNumber

readFloatNumber