Package eu.simuline.util.sgml

Class SGMLParser.Buffer

java.lang.Object

eu.simuline.util.sgml.SGMLParser.Buffer

Enclosing class:

SGMLParser

static class SGMLParser.Buffer
extends Object

Class which buffers the read stream.

Field Summary

Fields

Modifier and Type	Field	Description
private char[]	bufferArray	The current buffer.
private int	end	The first index in bufferArray not read from reader or -1 if the end of the stream is reached.
private int	newStart	Set by readArray(eu.simuline.util.sgml.SGMLParser.CharTester) and read by getStartAndMove().
private Reader	reader	The reader buffered.
private int	start	The first index in bufferArray read in from reader but not returned by readArray(eu.simuline.util.sgml.SGMLParser.CharTester) or readChar().

Constructor Summary

Constructors

Constructor	Description
Buffer(Reader reader, int length)	Creates a new Buffer from the given reader with the given size.

Method Summary

Modifier and Type	Method	Description
(package private) char[]	getChars()	Returns the buffer of chars.
(package private) int	getEnd()	Get method for end.
(package private) int	getStart()	Get method for start.
(package private) int	getStartAndMove()	Moves newStart to start and returns the old value of start.
(package private) boolean	isEmpty()	Returns whether this buffer is currently empty.
(package private) boolean	reachedEOS()	Returns whether the end of the stream is reached.
(package private) int	readArray(SGMLParser.CharTester charTester)	Reads an array from reader.
(package private) int	readChar()	Reads a single char and returns it.
(package private) StringBuffer	readStringBuffer(SGMLParser.CharTester charTester, String elementName)	Describe readStringBuffer method here.

Methods inherited from class java.lang.Object

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

Field Detail

reader

private final Reader reader

The reader buffered.

bufferArray

private final char[] bufferArray

The current buffer. The current parts to be read start with bufferArray[start] and end with bufferArray[end], exclusively.

start

private int start

The first index in bufferArray read in from reader but not returned by readArray(eu.simuline.util.sgml.SGMLParser.CharTester) or readChar().

newStart

private int newStart

Set by readArray(eu.simuline.util.sgml.SGMLParser.CharTester) and read by getStartAndMove(). When invoking readArray(eu.simuline.util.sgml.SGMLParser.CharTester) newStart is set to start and increased by the number of read charactersincreases. Then getStartAndMove() updates start according to newStart.

end

private int end

The first index in bufferArray not read from reader or -1 if the end of the stream is reached. This means that bufferArray[end] either does not exist or at least is not significant.

Constructor Detail

Buffer

Buffer(Reader reader,
       int length)
throws IOException

Creates a new Buffer from the given reader with the given size.

Parameters:

reader - the Reader to be buffered.

length - the length of the buffer.

Throws:

IOException - if an error occurs

Method Detail

isEmpty

boolean isEmpty()

Returns whether this buffer is currently empty. When this is the case and someone tries to read further characters this will lead to a trial to read further pieces from reader.

Returns:

a boolean value signifying whether this buffer is currently empty.

reachedEOS

boolean reachedEOS()

Returns whether the end of the stream is reached.

Returns:

a boolean specifying whether the end of the stream is reached.

readChar

int readChar()
      throws IOException

Reads a single char and returns it.

Returns:

an int value which is either the next char read in or -1 which signifies the end of the stream.

Throws:

IOException - if an error occurs

readArray

int readArray(SGMLParser.CharTester charTester)
       throws IOException

Reads an array from reader. As a side effect, writes the field newStart. Also, if the portion of bufferArray to be read, i.e. between start and end, is empty, a new portion is buffered.

Parameters:

charTester - a CharTester which signifies when to end reading from the buffer.

Returns:

an int signifying the number of chars read or -1 which signifies the end of the stream. It is read to the next < or, if there is none, to the end of the stream. Thus there is a difference between the return values -1 and 0.

Throws:

IOException - if an error occurs

readStringBuffer

StringBuffer readStringBuffer(SGMLParser.CharTester charTester,
                              String elementName)
                       throws IOException,
                              SAXParseException

Describe readStringBuffer method here.

Parameters:

charTester - a CharTester which determines the first character not read into the resulting StringBuffer.

elementName - a String which determines the element under consideration. This is only used for generating the message of a SAXParseException.

Allowed values: SGMLParser.START_TAG, SGMLParser.END_TAG, SGMLParser.PROC_INSTR, SGMLParser.ATTR_NAME, SGMLParser.WHITESP_IN_ATTR and SGMLParser.ATTR_VALUE. ****** comment and <!element missing.

Returns:

a StringBuffer containing characters starting with the current one until one charTester returns true.

Throws:

IOException - if an io-error occurs

SAXParseException - if the parser faces the end of the stream while scanning the current element.

getChars

char[] getChars()

Returns the buffer of chars.

Returns:

the char[] bufferArray.

getStartAndMove

int getStartAndMove()

Moves newStart to start and returns the old value of start.

Returns:

the old int value of start.

getStart

int getStart()

Get method for start.

Returns:

start

getEnd

int getEnd()

Get method for end.

Returns:

end