Package com.puppycrawl.tools.checkstyle.utils

Class BlockCommentPosition

java.lang.Object
com.puppycrawl.tools.checkstyle.utils.BlockCommentPosition
public final class BlockCommentPosition extends Object
Utility class that has methods to check javadoc comment position in java file.

  • Constructor Details

  • Method Details

    • isOnType

      public static boolean isOnType(DetailAST blockComment)
      Node is on type definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before class, interface, enum or annotation.

    • isOnClass

      public static boolean isOnClass(DetailAST blockComment)
      Node is on class definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before class

    • isOnRecord

      public static boolean isOnRecord(DetailAST blockComment)
      Node is on record definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before class

    • isOnPackage

      public static boolean isOnPackage(DetailAST blockComment)
      Node is on package definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before package

    • isOnInterface

      public static boolean isOnInterface(DetailAST blockComment)
      Node is on interface definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before interface

    • isOnEnum

      public static boolean isOnEnum(DetailAST blockComment)
      Node is on enum definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before enum

    • isOnAnnotationDef

      public static boolean isOnAnnotationDef(DetailAST blockComment)
      Node is on annotation definition.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before annotation

    • isOnMember

      public static boolean isOnMember(DetailAST blockComment)
      Node is on type member declaration.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before method, field, constructor, enum constant or annotation field

    • isOnMethod

      public static boolean isOnMethod(DetailAST blockComment)
      Node is on method declaration.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before method

    • isOnField

      public static boolean isOnField(DetailAST blockComment)
      Node is on field declaration.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before field

    • isOnConstructor

      public static boolean isOnConstructor(DetailAST blockComment)
      Node is on constructor.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before constructor

    • isOnCompactConstructor

      public 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.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before compact constructor

    • isOnEnumConstant

      public static boolean isOnEnumConstant(DetailAST blockComment)
      Node is on enum constant.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before enum constant

    • isOnAnnotationField

      public static boolean isOnAnnotationField(DetailAST blockComment)
      Node is on annotation field declaration.
      Parameters:
      blockComment - DetailAST
      Returns:
      true if node is before annotation field

    • isOnPlainToken

      private static boolean isOnPlainToken(DetailAST blockComment, int parentTokenType, int nextTokenType)
      Checks that block comment is on specified token without any modifiers.
      Parameters:
      blockComment - block comment start DetailAST
      parentTokenType - parent token type
      nextTokenType - next token type
      Returns:
      true if block comment is on specified token without modifiers

    • isOnTokenWithModifiers

      private static boolean isOnTokenWithModifiers(DetailAST blockComment, int tokenType)
      Checks that block comment is on specified token with modifiers.
      Parameters:
      blockComment - block comment start DetailAST
      tokenType - parent token type
      Returns:
      true if block comment is on specified token with modifiers

    • isOnTokenWithAnnotation

      private static boolean isOnTokenWithAnnotation(DetailAST blockComment, int tokenType)
      Checks that block comment is on specified token with annotation.
      Parameters:
      blockComment - block comment start DetailAST
      tokenType - parent token type
      Returns:
      true if block comment is on specified token with annotation

    • isOnPlainClassMember

      private static boolean isOnPlainClassMember(DetailAST blockComment)
      Checks that block comment is on specified class member without any modifiers.
      Parameters:
      blockComment - block comment start DetailAST
      Returns:
      true if block comment is on specified token without modifiers

    • getNextSiblingSkipComments

      private static DetailAST getNextSiblingSkipComments(DetailAST node)
      Get next sibling node skipping any comment nodes.
      Parameters:
      node - current node
      Returns:
      next sibling

    • getPrevSiblingSkipComments

      private static DetailAST getPrevSiblingSkipComments(DetailAST node)
      Get previous sibling node skipping any comments.
      Parameters:
      node - current node
      Returns:
      previous sibling