Package org.aspectj.org.eclipse.jdt.internal.formatter

Class TokenTraverser

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.formatter.TokenTraverser

Direct Known Subclasses:

CommentWrapExecutor, TextEditsBuilder

public abstract class TokenTraverser
extends Object

Helper class that can be subclassed every time an algorithm needs to swipe through all or part of the tokens and easily keep track or previous and future tokens and whitespace.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	counter	General purpose field that can be used by subclasses to count things
protected int	value	General purpose field that can be used by subclasses to store an integer value

Constructor Summary

Constructors

Constructor	Description
TokenTraverser()

Method Summary

Modifier and Type	Method	Description
protected Token	getCurrent()
protected int	getLineBreaksAfter()
protected int	getLineBreaksBefore()
protected Token	getNext()
protected Token	getPrevious()
protected boolean	isSpaceAfter()
protected boolean	isSpaceBefore()
protected void	structureChanged()	Must be called every time tokens are added or removed from the list that is currently being traversed so that cached data can be refreshed.
protected abstract boolean	token(Token token, int index)
int	traverse(List<Token> tokens, int startIndex)

Methods inherited from class java.lang.Object

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

Field Details

counter

protected int counter

General purpose field that can be used by subclasses to count things

value

protected int value

General purpose field that can be used by subclasses to store an integer value

Constructor Details

TokenTraverser

public TokenTraverser()

Method Details

token

protected abstract boolean token(Token token,
 int index)

structureChanged

protected void structureChanged()

Must be called every time tokens are added or removed from the list that is currently being traversed so that cached data can be refreshed.

isSpaceBefore

protected boolean isSpaceBefore()

isSpaceAfter

protected boolean isSpaceAfter()

getLineBreaksBefore

protected int getLineBreaksBefore()

getLineBreaksAfter

protected int getLineBreaksAfter()

getPrevious

protected Token getPrevious()

getCurrent

protected Token getCurrent()

getNext

protected Token getNext()

traverse

public int traverse(List<Token> tokens,
 int startIndex)