Package io.spring.javaformat.checkstyle.check

Class SpringJavadocCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
io.spring.javaformat.checkstyle.check.SpringJavadocCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable
public class SpringJavadocCheck extends com.puppycrawl.tools.checkstyle.api.AbstractCheck
Checks that the javadoc comments follow Spring conventions.
Author:
Phillip Webb

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

    com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int[]
    NO_REQUIRED_TOKENS
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpringJavadocCheck()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)
     
    int[]
    getAcceptableTokens()
     
    com.puppycrawl.tools.checkstyle.api.TextBlock
    getBlockCommentBefore(int lineNoBefore)
     
    int[]
    getDefaultTokens()
     
    int[]
    getRequiredTokens()
     
    void
    setAllowNonJavadocComments(boolean allowNonJavadocComments)
     
    void
    setPublicOnlySinceTags(boolean publicOnlySinceTags)
     
    void
    setRequireSinceTag(boolean requireSinceTag)
     
    void
    visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
     

    Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

    Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

    finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

    Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

    configure, contextualize, getConfiguration, setupChild

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • NO_REQUIRED_TOKENS

      public static final int[] NO_REQUIRED_TOKENS

  • Constructor Details

    • SpringJavadocCheck

      public SpringJavadocCheck()

  • Method Details

    • getDefaultTokens

      public int[] getDefaultTokens()

    • getAcceptableTokens

      public int[] getAcceptableTokens()
      Specified by:
      getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • beginTree

      public void beginTree(com.puppycrawl.tools.checkstyle.api.DetailAST rootAST)
      Overrides:
      beginTree in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • visitToken

      public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)
      Overrides:
      visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

    • getBlockCommentBefore

      public com.puppycrawl.tools.checkstyle.api.TextBlock getBlockCommentBefore(int lineNoBefore)

    • setRequireSinceTag

      public void setRequireSinceTag(boolean requireSinceTag)

    • setPublicOnlySinceTags

      public void setPublicOnlySinceTags(boolean publicOnlySinceTags)

    • setAllowNonJavadocComments

      public void setAllowNonJavadocComments(boolean allowNonJavadocComments)

    • getRequiredTokens

      public int[] getRequiredTokens()
      Specified by:
      getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck