eu.cqse.check.framework.util.tokens

Class TokenUtils

java.lang.Object

eu.cqse.check.framework.util.tokens.TokenUtils

public class TokenUtils
extends java.lang.Object

Utility methods for ITokens.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.EnumSet<ETokenType>	ALWAYS_CASE_SENSITIVE_TOKEN_TYPES Set of token types that always have to be treated case-sensitive, e.g.

Constructor Summary

Constructors

Constructor and Description
TokenUtils()

Method Summary

Modifier and Type	Method and Description
static int	calculateEndLineByCountingLines(IToken token) Calculates the zero-based end line of the specified token by counting the lines of the text contained within.
static int	estimateEndLineByLookahead(IToken token, IToken nextToken) Estimates the zero-based end line of the specified token by looking where the provided next token begins.
static Pair<TokenPattern,TokenPatternMatch>	getMatchingPattern(java.util.Collection<TokenPattern> patterns, java.util.List<IToken> tokens) Returns the first matching pattern and the match or null if no pattern matches.
static int	getTokenLineCount(java.util.EnumSet<ETokenType.ETokenClass> tokenClassesToPreserve, java.util.List<IToken> tokens, java.util.Set<java.lang.Integer> coveredLines) Creates a representation of the tokens that contains only the tokens specified in the parameter.
static boolean	isCommentToken(IToken token) Returns true if a given token is a comment token.
static boolean	isEqualTypeAndText(IToken t1, IToken t2) Checks if the given tokens are of equal type and have the equal text.

Methods inherited from class java.lang.Object

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

Field Detail

ALWAYS_CASE_SENSITIVE_TOKEN_TYPES

public static final java.util.EnumSet<ETokenType> ALWAYS_CASE_SENSITIVE_TOKEN_TYPES

Set of token types that always have to be treated case-sensitive, e.g. String literals.

Constructor Detail

TokenUtils

public TokenUtils()

Method Detail

estimateEndLineByLookahead

public static int estimateEndLineByLookahead(IToken token,
                                             IToken nextToken)

Estimates the zero-based end line of the specified token by looking where the provided next token begins. Note that this cannot check, if the provided next token is really the next token, nor if there are blank lines between the two tokens.

This method is more efficient than calculateEndLineByCountingLines(IToken), but not as precise.

Parameters:

token - the token whose end line should be calculated.

nextToken - the lookahead token.

Returns:

the end line of the specified first token.

calculateEndLineByCountingLines

public static int calculateEndLineByCountingLines(IToken token)

Calculates the zero-based end line of the specified token by counting the lines of the text contained within.

This method is less efficient than estimateEndLineByLookahead(IToken, IToken), but always yields the correct result.

Parameters:

token - the token whose end line should be calculated.

Returns:

the end line of the specified token.

isEqualTypeAndText

public static boolean isEqualTypeAndText(IToken t1,
                                         IToken t2)

Checks if the given tokens are of equal type and have the equal text. The method is null-safe.

Returns:

true if both tokens are null or if both tokens are of the same ETokenType and have the same text, false otherwise.

getMatchingPattern

public static Pair<TokenPattern,TokenPatternMatch> getMatchingPattern(java.util.Collection<TokenPattern> patterns,
                                                                      java.util.List<IToken> tokens)

Returns the first matching pattern and the match or null if no pattern matches.

isCommentToken

public static boolean isCommentToken(IToken token)

Returns true if a given token is a comment token.

getTokenLineCount

public static int getTokenLineCount(java.util.EnumSet<ETokenType.ETokenClass> tokenClassesToPreserve,
                                    java.util.List<IToken> tokens,
                                    java.util.Set<java.lang.Integer> coveredLines)

Creates a representation of the tokens that contains only the tokens specified in the parameter. This method keeps the original line breaks.

Parameters:

coveredLines - the method will only count lines that are not already in the given set. The set will afterwards contain all lines covered by the remaining tokens.