Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocVariableCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class JavadocVariableCheck extends AbstractCheck
Checks that a variable has a Javadoc comment. Ignores serialVersionUID fields.
  • Property accessModifiers - Specify the set of access modifiers used to determine which fields should be checked. This includes both explicitly declared modifiers and implicit ones, such as package-private for fields without an explicit modifier. It also accounts for special cases where fields have implicit modifiers, such as public static final for interface fields and public static for enum constants. Only fields matching the specified modifiers will be analyzed. Type is com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption[]. Default value is public, protected, package, private.
  • Property ignoreNamePattern - Specify the regexp to define variable names to ignore. Type is java.util.regex.Pattern. Default value is null.
  • Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: ENUM_CONSTANT_DEF.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • javadoc.missing
Since:
3.0

  • Field Details

    • MSG_JAVADOC_MISSING

      public static final String MSG_JAVADOC_MISSING
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • accessModifiers

      private AccessModifierOption[] accessModifiers
      Specify the set of access modifiers used to determine which fields should be checked. This includes both explicitly declared modifiers and implicit ones, such as package-private for fields without an explicit modifier. It also accounts for special cases where fields have implicit modifiers, such as public static final for interface fields and public static for enum constants. Only fields matching the specified modifiers will be analyzed.

    • ignoreNamePattern

      private Pattern ignoreNamePattern
      Specify the regexp to define variable names to ignore.

  • Constructor Details

  • Method Details

    • setAccessModifiers

      public void setAccessModifiers(AccessModifierOption... accessModifiers)
      Setter to specify the set of access modifiers used to determine which fields should be checked. This includes both explicitly declared modifiers and implicit ones, such as package-private for fields without an explicit modifier. It also accounts for special cases where fields have implicit modifiers, such as public static final for interface fields and public static for enum constants. Only fields matching the specified modifiers will be analyzed.
      Parameters:
      accessModifiers - access modifiers of fields to check.
      Since:
      10.22.0

    • setIgnoreNamePattern

      public void setIgnoreNamePattern(Pattern pattern)
      Setter to specify the regexp to define variable names to ignore.
      Parameters:
      pattern - a pattern.
      Since:
      5.8

    • getDefaultTokens

      public int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
      Specified by:
      getDefaultTokens in class AbstractCheck
      Returns:
      the default tokens
      See Also:

    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Description copied from class: AbstractCheck
      The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:

    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • isIgnored

      private boolean isIgnored(DetailAST ast)
      Decides whether the variable name of an AST is in the ignore list.
      Parameters:
      ast - the AST to check
      Returns:
      true if the variable name of ast is in the ignore list.

    • matchAccessModifiers

      private boolean matchAccessModifiers(AccessModifierOption accessModifier)
      Checks whether a method has the correct access modifier to be checked.
      Parameters:
      accessModifier - the access modifier of the method.
      Returns:
      whether the method matches the expected access modifier.

    • shouldCheck

      private boolean shouldCheck(DetailAST ast)
      Whether we should check this node.
      Parameters:
      ast - a given node.
      Returns:
      whether we should check a given node.