com.uwyn.jhighlight.highlighter
Interface ExplicitStateHighlighter

All Known Implementing Classes:

CppHighlighter, GroovyHighlighter, JavaHighlighter, XmlHighlighter

public interface ExplicitStateHighlighter

Provides access to the lexical scanning of a highlighted language.

Since:

1.0

Version:

$Revision: 3108 $

Author:

Omnicore Software, Hans Kratz & Dennis Strein GbR, Geert Bevin (gbevin[remove] at uwyn dot com)

Method Summary

byte	getNextToken() Obtain the next token from the scanner.
int	getTokenLength() Returns the length of the matched text region.
void	setReader(Reader reader) Sets the reader that will be used to receive the text data.

Method Detail

setReader

void setReader(Reader reader)

Sets the reader that will be used to receive the text data.

Parameters:

reader - the Reader that has to be used

getNextToken

byte getNextToken()
                  throws IOException

Obtain the next token from the scanner.

Returns:

one of the tokens that are define in the scanner

Throws:

IOException - when an error occurred during the parsing of the reader

getTokenLength

int getTokenLength()

Returns the length of the matched text region.

Returns:

the length of the matched text region