Class SpringImportOrderCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
io.spring.javaformat.checkstyle.check.SpringImportOrderCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class SpringImportOrderCheck extends com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck
Checks that the order of imports follow Spring conventions.
Author:
Vedran Pavic
  • 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 String
    The default root package.

    Fields inherited from class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck

    MSG_ORDERING, MSG_SEPARATED_IN_GROUP, MSG_SEPARATION
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setProjectRootPackage(String projectRootPackage)
     

    Methods inherited from class com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck

    beginTree, getAcceptableTokens, getDefaultTokens, getRequiredTokens, setCaseSensitive, setGroups, setOption, setOrdered, setSeparated, setSeparatedStaticGroups, setSortStaticImportsAlphabetically, setStaticGroups, setUseContainerOrderingForStatic, visitToken

    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

    • DEFAULT_PROJECT_ROOT_PACKAGE

      public static final String DEFAULT_PROJECT_ROOT_PACKAGE
      The default root package.
      See Also:
  • Constructor Details

    • SpringImportOrderCheck

      public SpringImportOrderCheck()
  • Method Details

    • setProjectRootPackage

      public void setProjectRootPackage(String projectRootPackage)