Class BlockCommentPosition
java.lang.Object
com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
Utility class that has methods to check javadoc comment position in java file.
-
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
isOnAnnotationDef
(DetailAST blockComment) Node is on annotation definition.static boolean
isOnAnnotationField
(DetailAST blockComment) Node is on annotation field declaration.static boolean
Node is on class definition.static boolean
isOnCompactConstructor
(DetailAST blockComment) Node is on compact constructor, note that we don't need to check for a plain token here, since a compact constructor must be public.static boolean
isOnConstructor
(DetailAST blockComment) Node is on constructor.static boolean
Node is on enum definition.static boolean
isOnEnumConstant
(DetailAST blockComment) Node is on enum constant.static boolean
Node is on field declaration.static boolean
isOnInterface
(DetailAST blockComment) Node is on interface definition.static boolean
isOnMember
(DetailAST blockComment) Node is on type member declaration.static boolean
isOnMethod
(DetailAST blockComment) Node is on method declaration.static boolean
isOnPackage
(DetailAST blockComment) Node is on package definition.static boolean
isOnRecord
(DetailAST blockComment) Node is on record definition.static boolean
Node is on type definition.
-
Method Details
-
isOnType
Node is on type definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before class, interface, enum or annotation.
-
isOnClass
Node is on class definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before class
-
isOnRecord
Node is on record definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before class
-
isOnPackage
Node is on package definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before package
-
isOnInterface
Node is on interface definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before interface
-
isOnEnum
Node is on enum definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before enum
-
isOnAnnotationDef
Node is on annotation definition.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before annotation
-
isOnMember
Node is on type member declaration.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before method, field, constructor, enum constant or annotation field
-
isOnMethod
Node is on method declaration.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before method
-
isOnField
Node is on field declaration.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before field
-
isOnConstructor
Node is on constructor.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before constructor
-
isOnCompactConstructor
Node is on compact constructor, note that we don't need to check for a plain token here, since a compact constructor must be public.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before compact constructor
-
isOnEnumConstant
Node is on enum constant.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before enum constant
-
isOnAnnotationField
Node is on annotation field declaration.- Parameters:
blockComment
- DetailAST- Returns:
- true if node is before annotation field
-