Class Main.CliOptions

    • Field Detail

      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • tabWidth

        private int tabWidth
        Tab character length. Suppression: CanBeFinal - we use picocli and it use reflection to manage such fields
      • 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.
    • Method Detail

      • getExclusions

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

        private List<StringvalidateCli​(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