Interface Token
- 
 @InternalApi public interface Token A token is an individual element of a SQL statement.The available implementations of Tokenare primarily guided by the implementation of the tokenization and the needs of the parser and included visitors. It does not distinguish all types of tokens. For example there isQuotedIdentifierTokenbecause the tokenization needs handling for quoted identifiers, while a normal identifier is aGenericToken, because that is handled by the fallback tokenization after checking for all other types. On the other hand, open and close curly braces, square brackets and parentheses each have their own type, as the parser may need this to find nested contexts.- Since:
- 5
- Author:
- Mark Rotteveel
 
- 
- 
Method SummaryAll Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default voidappendTo(java.lang.StringBuilder sb)Appends the current token to the supplied String builder.default booleanequalsIgnoreCase(java.lang.String tokenText)Case-insensitive equality of this tokens text using an equivalent ofString.equalsIgnoreCase(String).default booleanisValidIdentifier()Detects if the token is valid as an identifier (ignoring length constraints).default booleanisWhitespaceOrComment()intlength()Token text length.intposition()Token position.java.lang.Stringtext()Token text.default java.lang.CharSequencetextAsCharSequence()Token text asCharSequence.
 
- 
- 
- 
Method Detail- 
textjava.lang.String text() Token text.- Returns:
- the text of the token; this is the original text from the source
- See Also:
- textAsCharSequence()
 
 - 
textAsCharSequencedefault java.lang.CharSequence textAsCharSequence() Token text asCharSequence.Default implementation returns text(). As an optimization, implementations may return their containedCharSequenceto avoid unnecessary conversion to string.- Returns:
- the text of the token; this is the original text from the source
- See Also:
- text()
 
 - 
appendTodefault void appendTo(java.lang.StringBuilder sb) Appends the current token to the supplied String builder.- Parameters:
- sb- String builder to append to
 
 - 
positionint position() Token position.- Returns:
- 0-based position of the occurrence of this token in the source (the first character)
 
 - 
lengthint length() Token text length.- Returns:
- Length of the token text
 
 - 
isWhitespaceOrCommentdefault boolean isWhitespaceOrComment() - Returns:
- trueif this token is whitespace or a comment,- falsefor all other tokens
 
 - 
equalsIgnoreCasedefault boolean equalsIgnoreCase(java.lang.String tokenText) Case-insensitive equality of this tokens text using an equivalent ofString.equalsIgnoreCase(String).- Parameters:
- tokenText- Token text to compare
- Returns:
- trueif- tokenTextis equal - ignoring case - to the text of this token,- falseotherwise
 
 - 
isValidIdentifierdefault boolean isValidIdentifier() Detects if the token is valid as an identifier (ignoring length constraints).This will always return falseforReservedTokenor other specialised tokens (e.g.OperatorTokenwithISorLIKE) that can't occur as an identifier.- Returns:
- trueif the token is valid as an identifier,- falseotherwise
 
 
- 
 
-