java.lang.Object
- com.puppycrawl.tools.checkstyle.Main.CliOptions

Enclosing class:: Main

private static final class Main.CliOptions
extends Object

Command line options.

Field Summary

Fields
Modifier and Type	Field	Description
`private static String`	`ATTRIB_TAB_WIDTH_NAME`	Name for the moduleConfig attribute 'tabWidth'.
`private static int`	`CHECKER_THREADS_NUMBER`	The checker threads number.
`private String`	`configurationFile`	Config file location.
`private boolean`	`debug`	Option that controls whether to print debug info.
`private static Main.OutputFormat`	`DEFAULT_OUTPUT_FORMAT`	Default output format.
`private static int`	`DEFAULT_THREAD_COUNT`	The default number of threads to use for checker and the tree walker.
`private List<File>`	`exclude`	Option that allows users to specify a list of paths to exclude.
`private List<Pattern>`	`excludeRegex`	Option that allows users to specify a regex of paths to exclude.
`private boolean`	`executeIgnoredModules`	Switch whether to execute ignored modules or not.
`private List<File>`	`files`	List of file to validate.
`private Main.OutputFormat`	`format`	Output format.
`private boolean`	`generateXpathSuppressionsFile`	Switch whether to generate suppressions file or not.
`private static int`	`HELP_WIDTH`	Width of CLI help option.
`private static String`	`OUTPUT_FORMAT_OPTION`	Option name for output format.
`private Path`	`outputPath`	Output file location.
`private boolean`	`printAst`	Option that controls whether to print the AST of the file.
`private boolean`	`printAstWithComments`	Option that controls whether to print the AST of the file including comments.
`private boolean`	`printJavadocTree`	Option that controls whether to print the parse tree of the javadoc comment.
`private boolean`	`printTreeWithJavadoc`	Option that controls whether to print the full AST of the file.
`private File`	`propertiesFile`	Properties file location.
`private String`	`suppressionLineColumnNumber`	LineNo and columnNo for the suppression.
`private int`	`tabWidth`	Tab character length.
`private static int`	`TREE_WALKER_THREADS_NUMBER`	The tree walker threads number.
`private String`	`xpath`	Show AST branches that match xpath.

Constructor Summary

Constructors
Modifier Constructor Description

private CliOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private List<Pattern>`	`getExclusions()`	Gets the list of exclusions provided through the command line arguments.
`private List<String>`	`validateCli(picocli.CommandLine.ParseResult parseResult, List<File> filesToProcess)`	Validates the user-specified command line options.
`private List<String>`	`validateOptionalCliParametersIfConfigDefined()`	Validates optional command line parameters that might be used with config file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HELP_WIDTH
```
private static final int HELP_WIDTH
```
    Width of CLI help option.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - ATTRIB_TAB_WIDTH_NAME
```
private static final String ATTRIB_TAB_WIDTH_NAME
```
    Name for the moduleConfig attribute 'tabWidth'.
    
    See Also:
    
    Constant Field Values
  - 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:
    
    Constant Field Values
  - CHECKER_THREADS_NUMBER
```
private static final int CHECKER_THREADS_NUMBER
```
    The checker threads number. 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.
    
    See Also:
    
    Constant Field Values
  - 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.
  - generateXpathSuppressionsFile
```
private boolean generateXpathSuppressionsFile
```
    Switch whether to generate suppressions file or not.
  - format
```
private Main.OutputFormat format
```
    Output format.
  - 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.
  - excludeRegex
```
private List<Pattern> excludeRegex
```
    Option that allows users to specify a regex of paths to exclude.
  - executeIgnoredModules
```
private boolean executeIgnoredModules
```
    Switch whether to execute ignored modules or not.
  - xpath
```
private String xpath
```
    Show AST branches that match xpath.
- Constructor Detail
  - CliOptions
```
private CliOptions()
```
- Method Detail
  - 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

Class Main.CliOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HELP_WIDTH

DEFAULT_THREAD_COUNT

ATTRIB_TAB_WIDTH_NAME

DEFAULT_OUTPUT_FORMAT

OUTPUT_FORMAT_OPTION

CHECKER_THREADS_NUMBER

TREE_WALKER_THREADS_NUMBER

files

configurationFile

outputPath

propertiesFile

suppressionLineColumnNumber

tabWidth

generateXpathSuppressionsFile

format

printAst

printAstWithComments

printJavadocTree

printTreeWithJavadoc

debug

exclude

excludeRegex

executeIgnoredModules

xpath

Constructor Detail

CliOptions

Method Detail

getExclusions

validateCli

validateOptionalCliParametersIfConfigDefined