Class Main.CliOptions

java.lang.Object
com.puppycrawl.tools.checkstyle.Main.CliOptions
Enclosing class:
Main

private static class Main.CliOptions extends Object
Command line options.
  • Field Details

    • HELP_WIDTH

      private static final int HELP_WIDTH
      Width of CLI help option.
      See Also:
    • DEFAULT_THREAD_COUNT

      private static final int DEFAULT_THREAD_COUNT
      The default number of threads to use for checker and the tree walker.
      See Also:
    • ATTRIB_TAB_WIDTH_NAME

      private static final String ATTRIB_TAB_WIDTH_NAME
      Name for the moduleConfig attribute 'tabWidth'.
      See Also:
    • DEFAULT_OUTPUT_FORMAT

      private static final Main.OutputFormat DEFAULT_OUTPUT_FORMAT
      Default output format.
    • OUTPUT_FORMAT_OPTION

      private static final String OUTPUT_FORMAT_OPTION
      Option name for output format.
      See Also:
    • CHECKER_THREADS_NUMBER

      private static final int CHECKER_THREADS_NUMBER
      The checker threads number. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields This option has been skipped for CLI options intentionally.
      See Also:
    • TREE_WALKER_THREADS_NUMBER

      private static final int TREE_WALKER_THREADS_NUMBER
      The tree walker threads number. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields This option has been skipped for CLI options intentionally.
      See Also:
    • files

      private List<File> files
      List of file to validate.
    • configurationFile

      private String configurationFile
      Config file location.
    • outputPath

      private Path outputPath
      Output file location.
    • propertiesFile

      private File propertiesFile
      Properties file location.
    • suppressionLineColumnNumber

      private String suppressionLineColumnNumber
      LineNo and columnNo for the suppression.
    • tabWidth

      private int tabWidth
      Tab character length. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields
    • generateXpathSuppressionsFile

      private boolean generateXpathSuppressionsFile
      Switch whether to generate suppressions file or not.
    • format

      private Main.OutputFormat format
      Output format. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields
    • printAst

      private boolean printAst
      Option that controls whether to print the AST of the file.
    • printAstWithComments

      private boolean printAstWithComments
      Option that controls whether to print the AST of the file including comments.
    • printJavadocTree

      private boolean printJavadocTree
      Option that controls whether to print the parse tree of the javadoc comment.
    • printTreeWithJavadoc

      private boolean printTreeWithJavadoc
      Option that controls whether to print the full AST of the file.
    • debug

      private boolean debug
      Option that controls whether to print debug info.
    • exclude

      private List<File> exclude
      Option that allows users to specify a list of paths to exclude. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields
    • excludeRegex

      private List<Pattern> excludeRegex
      Option that allows users to specify a regex of paths to exclude. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields
    • executeIgnoredModules

      private boolean executeIgnoredModules
      Switch whether to execute ignored modules or not.
    • xpath

      private String xpath
      Show AST branches that match xpath.
  • Constructor Details

    • CliOptions

      private CliOptions()
  • Method Details

    • getExclusions

      private List<Pattern> getExclusions()
      Gets the list of exclusions provided through the command line arguments.
      Returns:
      List of exclusion patterns.
    • validateCli

      private List<String> validateCli(picocli.CommandLine.ParseResult parseResult, List<File> filesToProcess)
      Validates the user-specified command line options.
      Parameters:
      parseResult - used to verify if the format option was specified on the command line
      filesToProcess - the list of files whose style to check
      Returns:
      list of violations
    • validateOptionalCliParametersIfConfigDefined

      private List<String> validateOptionalCliParametersIfConfigDefined()
      Validates optional command line parameters that might be used with config file.
      Returns:
      list of violations