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

Class TokenManager

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.formatter.TokenManager

All Implemented Interfaces:

java.lang.Iterable<Token>

public class TokenManager
extends java.lang.Object
implements java.lang.Iterable<Token>

A helper class that can be used to easily access source code and find tokens on any position. It also has some other methods that are useful on multiple stages of formatting.

Constructor Summary

Constructors

Constructor and Description
TokenManager(java.util.List<Token> tokens, java.lang.String source, DefaultCodeFormatterOptions options)
TokenManager(java.util.List<Token> tokens, TokenManager parent)

Method Summary

Modifier and Type	Method and Description
void	addDisableFormatTokenPair(Token formatOffTag, Token formatOnTag)
void	addNLSAlignIndex(int index, int align)
void	applyFormatOff()
char	charAt(int sourcePosition)
int	countLineBreaksBetween(java.lang.String text, int startPosition, int endPosition)
int	countLineBreaksBetween(Token previous, Token current)
int	findFirstTokenInLine(int startIndex)
int	findFirstTokenInLine(int startIndex, boolean includeWraps, boolean includeForced)
int	findIndex(int positionInSource, int tokenType, boolean forward)
int	findSourcePositionInLine(int position)
int	firstIndexAfter(ASTNode node, int tokenType)
int	firstIndexBefore(ASTNode node, int tokenType)
int	firstIndexIn(ASTNode node, int tokenType)
Token	firstTokenAfter(ASTNode node, int tokenType)
Token	firstTokenBefore(ASTNode node, int tokenType)
Token	firstTokenIn(ASTNode node, int tokenType)
Token	get(int index)
int	getLength(int originalStart, int originalEnd, int startPosition) Calculates the length of a source code fragment.
int	getLength(Token token, int startPosition)
int	getNLSAlign(int index)
int	getPositionInLine(int tokenIndex)
java.lang.String	getSource()
int	getSourceLength()
int	indexOf(Token token)
void	insert(int tokenIndex, Token token) Adds given token at given index.
boolean	isGuardClause(Block node)
boolean	isInHeader(int tokenIndex)
java.util.Iterator<Token>	iterator()
int	lastIndexIn(ASTNode node, int tokenType)
Token	lastTokenIn(ASTNode node, int tokenType)
void	remove(int tokenIndex) Removes the token at given index.
void	setHeaderEndIndex(int headerEndIndex)
int	size()
int	toIndent(int indent, boolean isWrapped)
java.lang.String	toString(ASTNode node)
java.lang.String	toString(int tokenIndex) Gets token text with characters escaped as HTML entities where necessary.
java.lang.String	toString(Token token) Gets token text with characters escaped as HTML entities where necessary.
int	traverse(int startIndex, TokenTraverser traverser)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

TokenManager

public TokenManager(java.util.List<Token> tokens,
                    java.lang.String source,
                    DefaultCodeFormatterOptions options)

TokenManager

public TokenManager(java.util.List<Token> tokens,
                    TokenManager parent)

Method Detail

get

public Token get(int index)

size

public int size()

Returns:

total number of tokens

remove

public void remove(int tokenIndex)

Removes the token at given index.

Warning: never call this method after wrap policies have been added to tokens since wrap parent indexes may become invalid.

insert

public void insert(int tokenIndex,
                   Token token)

Adds given token at given index.

Warning: never call this method after wrap policies have been added to tokens since wrap parent indexes may become invalid.

toString

public java.lang.String toString(int tokenIndex)

Gets token text with characters escaped as HTML entities where necessary.

Parameters:

tokenIndex - index of the token to get.

toString

public java.lang.String toString(Token token)

Gets token text with characters escaped as HTML entities where necessary.

toString

public java.lang.String toString(ASTNode node)

Returns:

part of the source code defined by given node's position and length.

getSource

public java.lang.String getSource()

indexOf

public int indexOf(Token token)

charAt

public char charAt(int sourcePosition)

getSourceLength

public int getSourceLength()

findIndex

public int findIndex(int positionInSource,
                     int tokenType,
                     boolean forward)

iterator

public java.util.Iterator<Token> iterator()

Specified by:

iterator in interface java.lang.Iterable<Token>

isGuardClause

public boolean isGuardClause(Block node)

firstIndexIn

public int firstIndexIn(ASTNode node,
                        int tokenType)

firstTokenIn

public Token firstTokenIn(ASTNode node,
                          int tokenType)

lastIndexIn

public int lastIndexIn(ASTNode node,
                       int tokenType)

lastTokenIn

public Token lastTokenIn(ASTNode node,
                         int tokenType)

firstIndexAfter

public int firstIndexAfter(ASTNode node,
                           int tokenType)

firstTokenAfter

public Token firstTokenAfter(ASTNode node,
                             int tokenType)

firstIndexBefore

public int firstIndexBefore(ASTNode node,
                            int tokenType)

firstTokenBefore

public Token firstTokenBefore(ASTNode node,
                              int tokenType)

countLineBreaksBetween

public int countLineBreaksBetween(Token previous,
                                  Token current)

countLineBreaksBetween

public int countLineBreaksBetween(java.lang.String text,
                                  int startPosition,
                                  int endPosition)

getPositionInLine

public int getPositionInLine(int tokenIndex)

findSourcePositionInLine

public int findSourcePositionInLine(int position)

getLength

public int getLength(Token token,
                     int startPosition)

Parameters:

token - the token to measure

startPosition - position in line of the first character (affects tabs calculation)

Returns:

actual length of given token, considering tabs and escaping characters as HTML entities

getLength

public int getLength(int originalStart,
                     int originalEnd,
                     int startPosition)

Calculates the length of a source code fragment.

Parameters:

originalStart - the first position of the source code fragment

originalEnd - the last position of the source code fragment

startPosition - position in line of the first character (affects tabs calculation)

Returns:

length, considering tabs and escaping characters as HTML entities

toIndent

public int toIndent(int indent,
                    boolean isWrapped)

Parameters:

indent - desired indentation (in positions, not in levels)

isWrapped - whether indented element is wrapped

Returns:

actual indentation that can be achieved with current settings

traverse

public int traverse(int startIndex,
                    TokenTraverser traverser)

findFirstTokenInLine

public int findFirstTokenInLine(int startIndex)

findFirstTokenInLine

public int findFirstTokenInLine(int startIndex,
                                boolean includeWraps,
                                boolean includeForced)

addNLSAlignIndex

public void addNLSAlignIndex(int index,
                             int align)

getNLSAlign

public int getNLSAlign(int index)

setHeaderEndIndex

public void setHeaderEndIndex(int headerEndIndex)

isInHeader

public boolean isInHeader(int tokenIndex)

addDisableFormatTokenPair

public void addDisableFormatTokenPair(Token formatOffTag,
                                      Token formatOnTag)

applyFormatOff

public void applyFormatOff()