org.eclipse.jface.text.rules

Class BufferedDocumentScanner

java.lang.Object

org.eclipse.jface.text.rules.BufferedDocumentScanner

All Implemented Interfaces:

ICharacterScanner

public final class BufferedDocumentScanner
extends java.lang.Object
implements ICharacterScanner

A buffered document scanner. The buffer always contains a section of a fixed size of the document to be scanned.

Field Summary

Fields inherited from interface org.eclipse.jface.text.rules.ICharacterScanner

EOF

Constructor Summary

Constructors

Constructor and Description
BufferedDocumentScanner(int size) Creates a new buffered document scanner.

Method Summary

Modifier and Type	Method and Description
int	getColumn() Returns the column of the character scanner.
char[][]	getLegalLineDelimiters() Provides rules access to the legal line delimiters.
int	read() Returns the next character or EOF if end of file has been reached
void	setRange(IDocument document, int offset, int length) Configures the scanner by providing access to the document range over which to scan.
void	unread() Rewinds the scanner before the last read character.

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedDocumentScanner

public BufferedDocumentScanner(int size)

Creates a new buffered document scanner. The buffer size is set to the given number of characters.

Parameters:

size - the buffer size

Method Detail

setRange

public final void setRange(IDocument document,
                           int offset,
                           int length)

Configures the scanner by providing access to the document range over which to scan.

Parameters:

document - the document to scan

offset - the offset of the document range to scan

length - the length of the document range to scan

read

public final int read()

Description copied from interface: ICharacterScanner

Returns the next character or EOF if end of file has been reached

Specified by:

read in interface ICharacterScanner

Returns:

the next character or EOF

unread

public final void unread()

Description copied from interface: ICharacterScanner

Rewinds the scanner before the last read character.

Specified by:

unread in interface ICharacterScanner

getColumn

public final int getColumn()

Description copied from interface: ICharacterScanner

Returns the column of the character scanner.

Specified by:

getColumn in interface ICharacterScanner

Returns:

the column of the character scanner

getLegalLineDelimiters

public final char[][] getLegalLineDelimiters()

Description copied from interface: ICharacterScanner

Provides rules access to the legal line delimiters. The returned object may not be modified by clients.

Specified by:

getLegalLineDelimiters in interface ICharacterScanner

Returns:

the legal line delimiters