| Package | Description |
|---|---|
| com.puppycrawl.tools.checkstyle |
Contains the implementation of the Checkstyle framework.
|
| com.puppycrawl.tools.checkstyle.api |
Contains the core API to be used to implement checks.
|
| com.puppycrawl.tools.checkstyle.checks |
Contains the checks that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.header |
File Header checks.
|
| com.puppycrawl.tools.checkstyle.checks.javadoc |
Contains the Javadoc checks that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.regexp |
Contains the regular expression checks that are bundled with the main
distribution.
|
| com.puppycrawl.tools.checkstyle.checks.sizes |
Contains the Size Violations checks
that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.checks.whitespace |
Contains the Whitespace checks that
are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.filters |
Contains the filters that are bundled with the main distribution.
|
| com.puppycrawl.tools.checkstyle.gui |
User interface classes for CheckStyle.
|
| com.puppycrawl.tools.checkstyle.xpath |
Contains the nodes implementations for XPATH queries and query generator.
|
| Modifier and Type | Method and Description |
|---|---|
private static java.lang.String |
SuppressionsStringPrinter.generate(FileText fileText,
DetailAST detailAST,
int lineNumber,
int columnNumber,
int tabWidth)
Creates
XpathQueryGenerator instance and generates suppressions. |
static DetailAST |
JavaParser.parseFileText(FileText text,
JavaParser.Options options)
Parse a text and return the parse tree.
|
static java.lang.String |
AstTreeStringPrinter.printAst(FileText text,
JavaParser.Options options)
Parse a file and print the parse tree.
|
protected void |
TreeWalker.processFiltered(java.io.File file,
FileText fileText) |
| Modifier and Type | Field and Description |
|---|---|
private FileText |
FileContents.text
The text.
|
| Modifier and Type | Method and Description |
|---|---|
FileText |
FileContents.getText()
Get the full text of the file.
|
| Modifier and Type | Method and Description |
|---|---|
java.util.SortedSet<Violation> |
FileSetCheck.process(java.io.File file,
FileText fileText)
Request to process a file.
|
java.util.SortedSet<Violation> |
AbstractFileSetCheck.process(java.io.File file,
FileText fileText) |
protected abstract void |
AbstractFileSetCheck.processFiltered(java.io.File file,
FileText fileText)
Called to process a file that matches the specified file extensions.
|
| Constructor and Description |
|---|
FileContents(FileText text)
Creates a new
FileContents instance. |
FileText(FileText fileText)
Copy constructor.
|
| Modifier and Type | Method and Description |
|---|---|
private static int |
OrderedPropertiesCheck.getIndex(int startLineNo,
FileText fileText,
java.lang.String keyName)
Inner method to get the index number of the position of keyName.
|
private static int |
UniquePropertiesCheck.getLineNumber(FileText fileText,
java.lang.String keyName)
Method returns line number the key is detected in the checked properties
files first.
|
private static int |
OrderedPropertiesCheck.getLineNumber(int startLineNo,
FileText fileText,
java.lang.String previousProp,
java.lang.String propKey)
Method returns the index number where the key is detected (starting at 0).
|
protected void |
OrderedPropertiesCheck.processFiltered(java.io.File file,
FileText fileText)
Processes the file and check order.
|
protected void |
UniquePropertiesCheck.processFiltered(java.io.File file,
FileText fileText) |
protected void |
NewlineAtEndOfFileCheck.processFiltered(java.io.File file,
FileText fileText) |
protected void |
TranslationCheck.processFiltered(java.io.File file,
FileText fileText) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
HeaderCheck.processFiltered(java.io.File file,
FileText fileText) |
protected void |
RegexpHeaderCheck.processFiltered(java.io.File file,
FileText fileText) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
JavadocPackageCheck.processFiltered(java.io.File file,
FileText fileText) |
| Modifier and Type | Field and Description |
|---|---|
private FileText |
MultilineDetector.text
The file text content.
|
| Modifier and Type | Method and Description |
|---|---|
private boolean |
RegexpCheck.isIgnore(int startLine,
FileText text,
LineColumn start)
Detect ignore situation.
|
protected void |
RegexpOnFilenameCheck.processFiltered(java.io.File file,
FileText fileText) |
protected void |
RegexpMultilineCheck.processFiltered(java.io.File file,
FileText fileText) |
protected void |
RegexpSinglelineCheck.processFiltered(java.io.File file,
FileText fileText) |
void |
MultilineDetector.processLines(FileText fileText)
Processes an entire text file looking for matches.
|
void |
SinglelineDetector.processLines(FileText fileText)
Processes a set of lines looking for matches.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
FileLengthCheck.processFiltered(java.io.File file,
FileText fileText) |
protected void |
LineLengthCheck.processFiltered(java.io.File file,
FileText fileText) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
FileTabCharacterCheck.processFiltered(java.io.File file,
FileText fileText) |
| Modifier and Type | Method and Description |
|---|---|
private static FileText |
SuppressWithPlainTextCommentFilter.getFileText(java.lang.String fileName)
Returns
FileText instance created based on the given file name. |
| Modifier and Type | Method and Description |
|---|---|
private java.util.Optional<SuppressWithPlainTextCommentFilter.Suppression> |
SuppressWithPlainTextCommentFilter.getSuppression(FileText fileText,
int lineNo)
Tries to extract the suppression from the given line.
|
private java.util.List<SuppressWithPlainTextCommentFilter.Suppression> |
SuppressWithPlainTextCommentFilter.getSuppressions(FileText fileText)
Returns the list of
SuppressWithPlainTextCommentFilter.Suppression instances retrieved from the given FileText. |
| Modifier and Type | Method and Description |
|---|---|
private static FileText |
MainFrameModel.getFileText(java.io.File file)
Get FileText from a file.
|
| Modifier and Type | Field and Description |
|---|---|
private FileText |
XpathQueryGenerator.fileText
The
FileText object, representing content of the file. |
| Constructor and Description |
|---|
XpathQueryGenerator(DetailAST rootAst,
int lineNumber,
int columnNumber,
FileText fileText,
int tabWidth)
Creates a new
XpathQueryGenerator instance. |
XpathQueryGenerator(DetailAST rootAst,
int lineNumber,
int columnNumber,
int tokenType,
FileText fileText,
int tabWidth)
Creates a new
XpathQueryGenerator instance. |
Copyright © 2001-2022. All Rights Reserved.