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.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.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.utils |
Contains utils classes for checkstyle.
|
Modifier and Type | Method and Description |
---|---|
Object |
PackageObjectFactory.createModule(String name)
Creates a new instance of a class from a given name, or that name
concatenated with "Check".
|
Object |
ModuleFactory.createModule(String name)
Creates a new instance of a class from a given name.
|
protected void |
XMLLogger.finishLocalSetup() |
protected void |
DefaultLogger.finishLocalSetup() |
protected void |
Checker.finishLocalSetup() |
String |
DefaultConfiguration.getAttribute(String attributeName) |
static Set<String> |
PackageNamesLoader.getPackageNames(ClassLoader classLoader)
Returns the set of package names, compiled from all
checkstyle_packages.xml files found on the given class loaders
classpath.
|
static Configuration |
ConfigurationLoader.loadConfiguration(InputSource configSource,
PropertyResolver overridePropsResolver,
boolean omitIgnoredModules)
Deprecated.
in order to fulfill demands of BooleanParameter IDEA check.
|
static Configuration |
ConfigurationLoader.loadConfiguration(InputSource configSource,
PropertyResolver overridePropsResolver,
boolean omitIgnoredModules,
ThreadModeSettings threadModeSettings)
Deprecated.
in order to fulfill demands of BooleanParameter IDEA check.
|
static Configuration |
ConfigurationLoader.loadConfiguration(InputSource configSource,
PropertyResolver overridePropsResolver,
ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions)
Returns the module configurations from a specified input source.
|
static Configuration |
ConfigurationLoader.loadConfiguration(InputSource configSource,
PropertyResolver overridePropsResolver,
ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions,
ThreadModeSettings threadModeSettings)
Returns the module configurations from a specified input source.
|
static Configuration |
ConfigurationLoader.loadConfiguration(InputStream configStream,
PropertyResolver overridePropsResolver,
boolean omitIgnoredModules)
Deprecated.
As this method does not provide a valid system ID,
preventing resolution of external entities, a
version using an InputSource
should be used instead |
static Configuration |
ConfigurationLoader.loadConfiguration(String config,
PropertyResolver overridePropsResolver)
Returns the module configurations in a specified file.
|
static Configuration |
ConfigurationLoader.loadConfiguration(String config,
PropertyResolver overridePropsResolver,
boolean omitIgnoredModules)
Deprecated.
in order to fulfill demands of BooleanParameter IDEA check.
|
static Configuration |
ConfigurationLoader.loadConfiguration(String config,
PropertyResolver overridePropsResolver,
boolean omitIgnoredModules,
ThreadModeSettings threadModeSettings)
Deprecated.
in order to fulfill demands of BooleanParameter IDEA check.
|
static Configuration |
ConfigurationLoader.loadConfiguration(String config,
PropertyResolver overridePropsResolver,
ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions)
Returns the module configurations in a specified file.
|
static Configuration |
ConfigurationLoader.loadConfiguration(String config,
PropertyResolver overridePropsResolver,
ConfigurationLoader.IgnoredModulesOptions ignoredModulesOptions,
ThreadModeSettings threadModeSettings)
Returns the module configurations in a specified file.
|
static Configuration |
ConfigurationLoader.loadConfiguration(String config,
PropertyResolver overridePropsResolver,
ThreadModeSettings threadModeSettings)
Returns the module configurations in a specified file.
|
static DetailAST |
JavaParser.parse(FileContents contents)
Static helper method to parses a Java source file.
|
static DetailAST |
JavaParser.parseFile(File file,
JavaParser.Options options)
Parses Java source file.
|
static DetailAST |
JavaParser.parseFileText(FileText text,
JavaParser.Options options)
Parse a text and return the parse tree.
|
static String |
AstTreeStringPrinter.printAst(FileText text,
JavaParser.Options options)
Parse a file and print the parse tree.
|
static String |
AstTreeStringPrinter.printFileAst(File file,
JavaParser.Options options)
Parse a file and print the parse tree.
|
static String |
AstTreeStringPrinter.printJavaAndJavadocTree(File file)
Prints full AST (java + comments + javadoc) of the java file.
|
int |
Checker.process(List<File> files) |
protected void |
TreeWalker.processFiltered(File file,
FileText fileText) |
void |
TreeWalker.setupChild(Configuration childConf)
Called by configure() for every child of this component's Configuration.
|
protected void |
Checker.setupChild(Configuration childConf)
Called by configure() for every child of this component's Configuration.
|
Modifier and Type | Method and Description |
---|---|
void |
Configurable.configure(Configuration configuration)
Configures this component.
|
void |
AutomaticBean.configure(Configuration config)
Implements the Configurable interface using bean introspection.
|
void |
Contextualizable.contextualize(Context context)
Sets the context for this Component.
|
void |
AutomaticBean.contextualize(Context context)
Implements the Contextualizable interface using bean introspection.
|
protected abstract void |
AutomaticBean.finishLocalSetup()
Provides a hook to finish the part of this component's setup that
was not handled by the bean introspection.
|
protected void |
AbstractViolationReporter.finishLocalSetup() |
String |
Configuration.getAttribute(String name)
The attribute value for an attribute name.
|
SortedSet<LocalizedMessage> |
FileSetCheck.process(File file,
FileText fileText)
Request to process a file.
|
SortedSet<LocalizedMessage> |
AbstractFileSetCheck.process(File file,
FileText fileText) |
int |
RootModule.process(List<File> files)
Processes a set of files.
|
protected abstract void |
AbstractFileSetCheck.processFiltered(File file,
FileText fileText)
Called to process a file that matches the specified file extensions.
|
protected void |
AutomaticBean.setupChild(Configuration childConf)
Called by configure() for every child of this component's Configuration.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractHeaderCheck.finishLocalSetup() |
void |
AbstractHeaderCheck.setHeaderFile(URI uri)
Set the header file to check against.
|
Modifier and Type | Method and Description |
---|---|
protected void |
JavadocPackageCheck.processFiltered(File file,
FileText fileText) |
Modifier and Type | Method and Description |
---|---|
protected void |
RegexpOnFilenameCheck.processFiltered(File file,
FileText fileText) |
Modifier and Type | Method and Description |
---|---|
protected void |
SuppressionCommentFilter.finishLocalSetup() |
protected void |
SuppressWithPlainTextCommentFilter.finishLocalSetup() |
protected void |
SuppressWithNearbyCommentFilter.finishLocalSetup() |
protected void |
SuppressWarningsFilter.finishLocalSetup() |
protected void |
SeverityMatchFilter.finishLocalSetup() |
protected void |
SuppressionXpathFilter.finishLocalSetup() |
protected void |
SuppressionFilter.finishLocalSetup() |
static FilterSet |
SuppressionsLoader.loadSuppressions(String filename)
Returns the suppression filters in a specified file.
|
static Set<TreeWalkerFilter> |
SuppressionsLoader.loadXpathSuppressions(String filename)
Returns the suppression
TreeWalker filters in a specified file. |
Modifier and Type | Method and Description |
---|---|
void |
MainFrameModel.openFile(File file)
Open file and load the file.
|
Modifier and Type | Method and Description |
---|---|
static URI |
CommonUtils.getUriByFilename(String filename)
Resolve the specified filename to a URI.
|
Copyright © 2001–2018. All rights reserved.