org.eclipse.jface.text.rules

Interface ICharacterScanner

All Known Implementing Classes:

BufferedDocumentScanner, BufferedRuleBasedScanner, RuleBasedPartitionScanner, RuleBasedScanner

public interface ICharacterScanner

Defines the interface of a character scanner used by rules. Rules may request the next character or ask the character scanner to unread the last read character.

Field Summary

Fields

Modifier and Type	Field and Description
static int	EOF The value returned when this scanner has read EOF.

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	unread() Rewinds the scanner before the last read character.

Field Detail

EOF

static final int EOF

The value returned when this scanner has read EOF.

See Also:

Constant Field Values

Method Detail

getLegalLineDelimiters

char[][] getLegalLineDelimiters()

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

Returns:

the legal line delimiters

getColumn

int getColumn()

Returns the column of the character scanner.

Returns:

the column of the character scanner

read

int read()

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

Returns:

the next character or EOF

unread

void unread()

Rewinds the scanner before the last read character.