Class TokenUtils
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.utils.TokenUtils
-
public final class TokenUtils extends Object
Contains utility methods for tokens.- Author:
- Aleksey Nesterenko
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Optional<DetailAST>
findFirstTokenByPredicate(DetailAST root, Predicate<DetailAST> predicate)
static int[]
getAllTokenIds()
Get all token IDs that are available in TokenTypes.static int
getIntFromField(Field field, Object object)
Gets the value of a static or instance field of type int or of another primitive type convertible to type int via a widening conversion.static String
getShortDescription(String name)
Returns the short description of a token for a given name.static int
getTokenId(String name)
Returns the ID of a token for a given name.static String
getTokenName(int id)
Returns the name of a token for a given ID.static int
getTokenTypesTotalNumber()
Get total number of TokenTypes.static boolean
isCommentType(int type)
Is argument comment-related type (SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN, BLOCK_COMMENT_END, COMMENT_CONTENT).static boolean
isCommentType(String type)
Is argument comment-related type name (SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN, BLOCK_COMMENT_END, COMMENT_CONTENT).
-
-
-
Method Detail
-
getIntFromField
public static int getIntFromField(Field field, Object object)
Gets the value of a static or instance field of type int or of another primitive type convertible to type int via a widening conversion. Does not throw any checked exceptions.- Parameters:
field
- from which the int should be extractedobject
- to extract the int value from- Returns:
- the value of the field converted to type int
- Throws:
IllegalStateException
- if this Field object is enforcing Java language access control and the underlying field is inaccessible- See Also:
Field.getInt(Object)
-
getTokenTypesTotalNumber
public static int getTokenTypesTotalNumber()
Get total number of TokenTypes.- Returns:
- total number of TokenTypes.
-
getAllTokenIds
public static int[] getAllTokenIds()
Get all token IDs that are available in TokenTypes.- Returns:
- array of token IDs
-
getTokenName
public static String getTokenName(int id)
Returns the name of a token for a given ID.- Parameters:
id
- the ID of the token name to get- Returns:
- a token name
-
getTokenId
public static int getTokenId(String name)
Returns the ID of a token for a given name.- Parameters:
name
- the name of the token ID to get- Returns:
- a token ID
-
getShortDescription
public static String getShortDescription(String name)
Returns the short description of a token for a given name.- Parameters:
name
- the name of the token ID to get- Returns:
- a short description
-
isCommentType
public static boolean isCommentType(int type)
Is argument comment-related type (SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN, BLOCK_COMMENT_END, COMMENT_CONTENT).- Parameters:
type
- token type.- Returns:
- true if type is comment-related type.
-
isCommentType
public static boolean isCommentType(String type)
Is argument comment-related type name (SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN, BLOCK_COMMENT_END, COMMENT_CONTENT).- Parameters:
type
- token type name.- Returns:
- true if type is comment-related type name.
-
-