org.fife.rsta.ac.common

Class TokenScanner

java.lang.Object

org.fife.rsta.ac.common.TokenScanner

public class TokenScanner
extends java.lang.Object

Returns non-whitespace, non-comment tokens from an RSyntaxDocument, one at a time. This can be used by simplistic LanguageSupports to "parse" for simple, easily-identifiable tokens, such as curly braces and TokenTypes.VARIABLEs. For example, to identify code blocks for languages structured like C and Java, you can use this class in conjunction with CodeBlock and VariableDeclaration to create an easily-parsable model of your source code.

Constructor Summary

Constructors

Constructor and Description
TokenScanner(org.fife.ui.rsyntaxtextarea.RSyntaxDocument doc)
TokenScanner(org.fife.ui.rsyntaxtextarea.RSyntaxTextArea textArea)

Method Summary

Modifier and Type	Method and Description
org.fife.ui.rsyntaxtextarea.RSyntaxDocument	getDocument() Returns the document being parsed.
org.fife.ui.rsyntaxtextarea.Token	next() Returns the next non-whitespace, non-comment token in the text area.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenScanner

public TokenScanner(org.fife.ui.rsyntaxtextarea.RSyntaxTextArea textArea)

TokenScanner

public TokenScanner(org.fife.ui.rsyntaxtextarea.RSyntaxDocument doc)

Method Detail

getDocument

public org.fife.ui.rsyntaxtextarea.RSyntaxDocument getDocument()

Returns the document being parsed.

Returns:

The document.

next

public org.fife.ui.rsyntaxtextarea.Token next()

Returns the next non-whitespace, non-comment token in the text area.

Returns:

The next token, or null if we are at the end of its document.