Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractCheckstyleReport - Class in org.apache.maven.plugins.checkstyle
-
Base abstract class for Checkstyle reports.
- AbstractCheckstyleReport() - Constructor for class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- addAttributeIfNotExists(DefaultConfiguration, String, String) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- addError(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- addError(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- addException(AuditEvent, Throwable) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- addException(AuditEvent, Throwable) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- addFilesToProcess(CheckstyleExecutorRequest, Collection<File>, List<Resource>, List<Resource>, Collection<File>, Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- addListener(AuditListener) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- addResourceFilesToProcess(CheckstyleExecutorRequest, List<Resource>, Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- addSearchPath(String, String) - Method in class org.apache.maven.plugins.checkstyle.resource.LicenseResourceManager
- addSourceDirectory(File) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- addSourceDirectory(CheckstyleCheckerListener, Collection<File>, Collection<File>, List<Resource>, CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- aggregate - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- anyDirectoryExists(Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- auditFinished(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- auditFinished(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- auditStarted(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- auditStarted(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
B
- basedir - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- bundle - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- bundle - Variable in class org.apache.maven.plugins.checkstyle.IconTool
C
- cacheFile - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the cache file used to speed up Checkstyle on successive runs.
- cacheFile - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the cache file used to speed up Checkstyle on successive runs.
- cacheFile - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- canGenerateReport() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
- canGenerateReport() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReport
- category - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- ChainedItem(T, CheckstyleReportGenerator.ChainedItem<T>) - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ChainedItem
- checkDeprecatedParameterUsage(Object, String, String) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- checkDeprecatedParameterUsage(Object, String, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- CHECKSTYLE_FILE_HEADER - Static variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- CHECKSTYLE_PACKAGE - Static variable in class org.apache.maven.plugins.checkstyle.RuleUtil
- CheckstyleAggregateReport - Class in org.apache.maven.plugins.checkstyle
-
A reporting task that performs Checkstyle analysis and generates an aggregate HTML report on the violations that Checkstyle finds in a multi-module reactor build.
- CheckstyleAggregateReport() - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
- CheckstyleCheckerListener - Class in org.apache.maven.plugins.checkstyle.exec
-
Listener in charge of receiving events from the Checker.
- CheckstyleCheckerListener(Configuration) - Constructor for class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- CheckstyleCheckerListener(File) - Constructor for class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- CheckstyleCheckerListener(File, Configuration) - Constructor for class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- checkstyleConfig - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- checkstyleConfiguration - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- checkstyleExecutor - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- checkstyleExecutor - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- CheckstyleExecutor - Interface in org.apache.maven.plugins.checkstyle.exec
- CheckstyleExecutorException - Exception in org.apache.maven.plugins.checkstyle.exec
- CheckstyleExecutorException() - Constructor for exception org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorException(String) - Constructor for exception org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorException(String, Throwable) - Constructor for exception org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorException(Throwable) - Constructor for exception org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorRequest - Class in org.apache.maven.plugins.checkstyle.exec
- CheckstyleExecutorRequest() - Constructor for class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Constructor.
- CheckstyleReport - Class in org.apache.maven.plugins.checkstyle
-
A reporting task that performs Checkstyle analysis and generates an HTML report on any violations that Checkstyle finds.
- CheckstyleReport() - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReport
- CheckstyleReportGenerator - Class in org.apache.maven.plugins.checkstyle
-
Generate a report based on CheckstyleResults.
- CheckstyleReportGenerator(Sink, ResourceBundle, File, SiteTool, String) - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- CheckstyleReportGenerator.ChainedItem<T> - Class in org.apache.maven.plugins.checkstyle
- CheckstyleReportGenerator.ConfReference - Class in org.apache.maven.plugins.checkstyle
- CheckstyleResults - Class in org.apache.maven.plugins.checkstyle.exec
-
Object holding the references to the CheckstyleResults.
- CheckstyleResults() - Constructor for class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- checkstyleRssGenerator - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
CheckstyleRssGenerator.
- CheckstyleRssGenerator - Interface in org.apache.maven.plugins.checkstyle.rss
- CheckstyleRssGeneratorRequest - Class in org.apache.maven.plugins.checkstyle.rss
- CheckstyleRssGeneratorRequest(MavenProject, String, File, Log) - Constructor for class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- checkstyleRules - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
By using this property, you can specify the whole Checkstyle rules inline directly inside this pom.
- CheckstyleViolationCheckMojo - Class in org.apache.maven.plugins.checkstyle
-
Performs Checkstyle analysis and outputs violations or a count of violations to the console, potentially failing the build.
- CheckstyleViolationCheckMojo() - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- collectArtifacts(String) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- collectArtifacts(String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- compareTo(CheckstyleReportGenerator.ConfReference) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- CompositeAuditListener - Class in org.apache.maven.plugins.checkstyle
-
AuditListener that forwards events to a list of other AuditListeners
- CompositeAuditListener() - Constructor for class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- configLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the XML configuration to use.
- configLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the XML configuration to use.
- configLocation - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- configuration - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- configuration - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- configurationArtifacts - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- configureResourceLocator(ResourceManager, CheckstyleExecutorRequest, List<Artifact>) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
-
Configures search paths in the resource locator.
- ConfReference(String, Configuration, CheckstyleReportGenerator.ChainedItem<Configuration>, long, int) - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- consoleOutput - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Output errors to console.
- consoleOutput - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Output errors to console.
- consoleOutput - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- copy(String) - Method in class org.apache.maven.plugins.checkstyle.ReportResource
- copyright - Variable in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- count - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- countViolations(XmlPullParser) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- createRequest() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Create the Checkstyle executor request.
- createRequest() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
-
Create the Checkstyle executor request.
- createRequest() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReport
-
Create the Checkstyle executor request.
- currentFile - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
D
- DefaultCheckstyleExecutor - Class in org.apache.maven.plugins.checkstyle.exec
- DefaultCheckstyleExecutor() - Constructor for class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- DefaultCheckstyleRssGenerator - Class in org.apache.maven.plugins.checkstyle.rss
- DefaultCheckstyleRssGenerator() - Constructor for class org.apache.maven.plugins.checkstyle.rss.DefaultCheckstyleRssGenerator
- defaultLogger - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- delegates - Variable in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- doDetails(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- doFileEvents(List<AuditEvent>, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- doFilesSummary(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- doHeading() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- doRuleRow(CheckstyleReportGenerator.ConfReference, CheckstyleResults, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
-
Create a summary for one Checkstyle rule.
- doRulesSummary(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
-
Create the rules summary section of the report.
- doSeveritySummary(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
E
- enableFilesSummary - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies if the Files summary should be enabled or not.
- enableFilesSummary - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- enableRSS - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies if the RSS should be enabled or not.
- enableRSS - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- enableRulesSummary - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies if the Rules summary should be enabled or not.
- enableRulesSummary - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- enableSeveritySummary - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies if the Severity summary should be enabled or not.
- enableSeveritySummary - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- encoding - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
The file encoding to use when reading the source files.
- encoding - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The file encoding to use when reading the source files.
- encoding - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- ERROR - Static variable in class org.apache.maven.plugins.checkstyle.IconTool
- events - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- excludes - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the names filter of the source files to be excluded for Checkstyle.
- excludes - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the names filter of the source files to be excluded for Checkstyle.
- excludes - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Specifies the names filter of the source files to be excluded for Checkstyle.
- execute() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- executeCheckstyle(CheckstyleExecutorRequest) - Method in interface org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutor
- executeCheckstyle(CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- executeReport(Locale) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- executeReport(Locale) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReport
- ExtensionMatcher() - Constructor for class org.apache.maven.plugins.checkstyle.RuleUtil.ExtensionMatcher
F
- failOnViolation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Fail the build on a violation.
- failsOnError - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies if the build should fail upon a violation.
- failsOnError - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
If this is true, and Checkstyle reported any violations or errors, the build fails immediately after running Checkstyle, before checking the log for
CheckstyleViolationCheckMojo.logViolationsToConsole
. - failsOnError - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- fileFinished(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- fileFinished(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- files - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- fileStarted(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- fileStarted(AuditEvent) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
G
- generate(String, String, Context) - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
-
Using a specified Velocity Template and provided context, create the outputFilename.
- generateMainReport(CheckstyleResults, ResourceBundle) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- generateReport(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- generateReportStatics() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- generateRSS(CheckstyleResults, CheckstyleRssGeneratorRequest) - Method in interface org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGenerator
- generateRSS(CheckstyleResults, CheckstyleRssGeneratorRequest) - Method in class org.apache.maven.plugins.checkstyle.rss.DefaultCheckstyleRssGenerator
- getBundle(Locale) - Static method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getCacheFile() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getCategory(AuditEvent) - Static method in class org.apache.maven.plugins.checkstyle.RuleUtil
-
Get the rule category from an audit event.
- getCategory(String) - Static method in class org.apache.maven.plugins.checkstyle.RuleUtil
-
Get the rule category from an audit event source name.
- getCheckstyleConfig() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- getCheckstyleConfiguration() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- getCheckstylePluginDependenciesAsArtifacts(Map<String, Plugin>, String) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getCheckstylePluginDependenciesAsArtifacts(Map<String, Plugin>, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- getCheckstyleVersion() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
-
Get the effective Checkstyle version at runtime.
- getCheckstyleVersion() - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
-
Get the effective Checkstyle version at runtime.
- getConfigAttribute(Configuration, CheckstyleReportGenerator.ChainedItem<Configuration>, String, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
-
Get the value of the specified attribute from the Checkstyle configuration.
- getConfigFile(CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- getConfigLocation() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getConfiguration() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getConfiguration(CheckstyleExecutorRequest) - Method in interface org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutor
- getConfiguration(CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- getConfigurationArtifacts() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns a list of artifacts, which may contain the checkstyle configuration.
- getConsoleListener() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Creates and returns the console listener.
- getConsoleListener() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- getConsoleListener() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getCopyright() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getCopyright() - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- getDescription(Locale) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getEncoding() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getExcludes() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getFileCount() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getFiles() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getFilesToProcess(CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- getFileViolations(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getHeaderLocation() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getIncludes() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns the includes parameter.
- getLicenseArtifacts() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns a list of license artifacts, which may contain the license.
- getListener() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Creates and returns the report generation listener.
- getListener() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- getListener() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getLog() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- getLog() - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- getLog() - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- getMavenProject() - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- getName(AuditEvent) - Static method in class org.apache.maven.plugins.checkstyle.RuleUtil
-
Get the rule name from an audit event.
- getName(String) - Static method in class org.apache.maven.plugins.checkstyle.RuleUtil
-
Get the rule name from an audit event source name.
- getName(Locale) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getOutputDirectory() - Method in class org.apache.maven.plugins.checkstyle.ReportResource
- getOutputDirectory() - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- getOutputName() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
- getOutputName() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReport
- getOutputStream(File) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getOutputStream(File) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- getOverridingProperties(CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- getProject() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
- getProject() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReport
- getProject() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getPropertiesLocation() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getPropertyExpansion() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getReactorProjects() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns the list of reactor projects.
- getResource(String) - Method in class org.apache.maven.plugins.checkstyle.resource.LicenseResourceManager
- getResourceExcludes() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getResourceIncludes() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getResourcePathBase() - Method in class org.apache.maven.plugins.checkstyle.ReportResource
- getResources() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getResults() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- getSeverityCount(SeverityLevel) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getSeverityCount(String, SeverityLevel) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getSeverityCount(List<AuditEvent>, SeverityLevel) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- getSeverityLevel() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- getSeverityLevelFilter() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- getSourceDirectories() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getSourceDirectories() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- getSourceDirectories() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getStringOutputStream() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getSuppressionsFileExpression() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getSuppressionsFilePath(CheckstyleExecutorRequest) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- getSuppressionsFilterSet(String) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- getSuppressionsLocation() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getTemplateDirectory() - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- getTestResources() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getTestSourceDirectories() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getTestSourceDirectories() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- getTestSourceDirectories() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getTitle() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- getTreeWalkerNames() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- getVelocity() - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- getXrefLocation() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
H
- hasResources(List<Resource>) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReport
-
Check if any of the resources exist.
- headerLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the License file (a.k.a.
- headerLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the License file (a.k.a.
- headerLocation - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
I
- iconError() - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render an error icon.
- iconError(int) - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render an error icon with associated text.
- iconInfo() - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render an info icon.
- iconInfo(int) - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render an info icon with associated text.
- iconSeverity(String) - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render a simple icon of given level.
- iconSeverity(String, int) - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render an icon of given level with associated text.
- iconTool - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- IconTool - Class in org.apache.maven.plugins.checkstyle
-
A little tool to deal with info/warning/error icons in Checkstyle reports, with eventual text.
- IconTool(Sink, ResourceBundle) - Constructor for class org.apache.maven.plugins.checkstyle.IconTool
- iconWarning() - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render a warning icon.
- iconWarning(int) - Method in class org.apache.maven.plugins.checkstyle.IconTool
-
Render a warning icon with associated text.
- ignore(RuleUtil.Matcher[], String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- includeResources - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies whether to include the resource directories in the check.
- includeResources - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Whether to apply Checkstyle to resource directories.
- includeResources - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- includes - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the names filter of the source files to be used for Checkstyle.
- includes - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the names filter of the source files to be used for Checkstyle.
- includes - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Specifies the names filter of the source files to be used for Checkstyle.
- includeTestResources - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies whether to include the test resource directories in the check.
- includeTestResources - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Whether to apply Checkstyle to test resource directories.
- includeTestResources - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- includeTestSourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Include or not the test source directory/directories to be used for Checkstyle.
- includeTestSourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Include or not the test source directory to be used for Checkstyle.
- includeTestSourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- INFO - Static variable in class org.apache.maven.plugins.checkstyle.IconTool
- isAggregate() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns true if the report is aggregated.
- isConsoleOutput() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- isEnableFilesSummary() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- isEnableRSS() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- isEnableRulesSummary() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- isEnableSeveritySummary() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- isFailsOnError() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- isIncludeResources() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- isIncludeTestResources() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- isIncludeTestSourceDirectory() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- isOmitIgnoredModules() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns true if ignored modules (modules with severity 'ignore') should be omitted.
- isViolation(String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Checks if the given severity is considered a violation.
J
- JAVA_FILES - Static variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- JAVA_FILES - Static variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
L
- licenseArtifacts - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- licenseLocator - Variable in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- LicenseResourceManager - Class in org.apache.maven.plugins.checkstyle.resource
-
License resource manager, to avoid defaulting license to maven-checkstyle-plugin's own license.
- LicenseResourceManager() - Constructor for class org.apache.maven.plugins.checkstyle.resource.LicenseResourceManager
- linkXRef - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Link the violation line numbers to the source xref.
- listener - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- locator - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- locator - Variable in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- log - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- log - Variable in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- log - Variable in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- log(String, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- logViolationsToConsole - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Output the detected violations to the console.
M
- match(String) - Method in class org.apache.maven.plugins.checkstyle.RuleUtil.ExtensionMatcher
- match(String) - Method in interface org.apache.maven.plugins.checkstyle.RuleUtil.Matcher
-
Does the event source name match?
- match(String) - Method in class org.apache.maven.plugins.checkstyle.RuleUtil.PackageMatcher
- match(String) - Method in class org.apache.maven.plugins.checkstyle.RuleUtil.RuleMatcher
- matchRule(AuditEvent, String, String, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
-
Check if a violation matches a rule.
- mavenProject - Variable in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- maxAllowedViolations - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The maximum number of allowed violations.
N
O
- omitIgnoredModules - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies whether modules with a configured severity of
ignore
should be omitted during Checkstyle invocation. - omitIgnoredModules - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies whether modules with a configured severity of
ignore
should be omitted during Checkstyle invocation. - omitIgnoredModules - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- org.apache.maven.plugins.checkstyle - package org.apache.maven.plugins.checkstyle
- org.apache.maven.plugins.checkstyle.exec - package org.apache.maven.plugins.checkstyle.exec
- org.apache.maven.plugins.checkstyle.resource - package org.apache.maven.plugins.checkstyle.resource
- org.apache.maven.plugins.checkstyle.rss - package org.apache.maven.plugins.checkstyle.rss
- outputDirectory - Variable in class org.apache.maven.plugins.checkstyle.ReportResource
- outputDirectory - Variable in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- outputFile - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the path and filename to save the Checkstyle output.
- outputFile - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the path and filename to save the Checkstyle output.
- outputFileFormat - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the format of the output to be used when writing to the output file.
- outputFileFormat - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the format of the output to be used when writing to the output file.
- outputXmlFile - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
P
- PackageMatcher(String) - Constructor for class org.apache.maven.plugins.checkstyle.RuleUtil.PackageMatcher
- packageName - Variable in class org.apache.maven.plugins.checkstyle.RuleUtil.PackageMatcher
- parent - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ChainedItem
- parentConfiguration - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- parseMatchers(String[]) - Static method in class org.apache.maven.plugins.checkstyle.RuleUtil
- plugin - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
The Plugin Descriptor
- plugin - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The Plugin Descriptor
- PLUGIN_RESOURCES - Static variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- prepareCheckstylePaths(CheckstyleExecutorRequest, MavenProject, List<String>, List<String>, Collection<File>, Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- project - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The Maven Project Object.
- project - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- propertiesLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the properties file.
- propertiesLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the properties file.
- propertiesLocation - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- propertyExpansion - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Allows for specifying raw property expansion information.
- propertyExpansion - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Allows for specifying raw property expansion information.
- propertyExpansion - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
R
- reactorProjects - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleAggregateReport
-
The projects in the reactor for aggregation report.
- reactorProjects - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- ReportResource - Class in org.apache.maven.plugins.checkstyle
-
Generic Report Resource management.
- ReportResource(String, File) - Constructor for class org.apache.maven.plugins.checkstyle.ReportResource
- resourceExcludes - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the names filter of the resource files to be excluded for Checkstyle.
- resourceExcludes - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the names filter of the files to be excluded for Checkstyle when checking resources.
- resourceExcludes - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Specifies names filter for resources.
- resourceIncludes - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the names filter of the resource files to be used for Checkstyle.
- resourceIncludes - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the names filter of the files to be used for Checkstyle when checking resources.
- resourceIncludes - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Specifies names filter for resources.
- resourceLoaders - Variable in class org.apache.maven.plugins.checkstyle.resource.LicenseResourceManager
- resourcePathBase - Variable in class org.apache.maven.plugins.checkstyle.ReportResource
- resources - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the resources to be used for Checkstyle.
- resources - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the resources to be used for Checkstyle.
- resources - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- results - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- rule - Variable in class org.apache.maven.plugins.checkstyle.RuleUtil.RuleMatcher
- RuleMatcher(String) - Constructor for class org.apache.maven.plugins.checkstyle.RuleUtil.RuleMatcher
- ruleset - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- rulesFiles - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Dump file for inlined Checkstyle rules.
- RuleUtil - Class in org.apache.maven.plugins.checkstyle
-
Tooling for Checkstyle rules conventions: names, categories.
- RuleUtil() - Constructor for class org.apache.maven.plugins.checkstyle.RuleUtil
- RuleUtil.ExtensionMatcher - Class in org.apache.maven.plugins.checkstyle
-
An extension does not start with Checkstyle package.
- RuleUtil.Matcher - Interface in org.apache.maven.plugins.checkstyle
-
Audit event source name matcher.
- RuleUtil.PackageMatcher - Class in org.apache.maven.plugins.checkstyle
- RuleUtil.RuleMatcher - Class in org.apache.maven.plugins.checkstyle
S
- serialVersionUID - Static variable in exception org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- setAggregate(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Sets the aggregate parameter.
- setCacheFile(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setCheckstyleConfig(Configuration) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setCheckstyleConfiguration(Configuration) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- setConfigLocation(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setConfiguration(Configuration) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- setConfigurationArtifacts(List<Artifact>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Sets a list of artifacts, which may contain the checkstyle configuration.
- setConsoleListener(DefaultLogger) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setConsoleOutput(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setCopyright(String) - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- setEnableFilesSummary(boolean) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setEnableRSS(boolean) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setEnableRulesSummary(boolean) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setEnableSeveritySummary(boolean) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setEncoding(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setExcludes(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setFailsOnError(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setFiles(Map<String, List<AuditEvent>>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- setFileViolations(String, List<AuditEvent>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleResults
- setHeaderLocation(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setIncludeResources(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setIncludes(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setIncludeTestResources(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setIncludeTestSourceDirectory(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setLicenseArtifacts(List<Artifact>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Sets a list of license artifacts, which may contain the license.
- setListener(AuditListener) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setLog(Log) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setLog(Log) - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- setLog(Log) - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- setMavenProject(MavenProject) - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- setOmitIgnoredModules(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setOutputDirectory(File) - Method in class org.apache.maven.plugins.checkstyle.ReportResource
- setOutputDirectory(File) - Method in class org.apache.maven.plugins.checkstyle.rss.CheckstyleRssGeneratorRequest
- setProject(MavenProject) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setPropertiesLocation(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setPropertyExpansion(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setReactorProjects(List<MavenProject>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Sets the list of reactor projects.
- setResourceExcludes(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setResourceIncludes(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setResourcePathBase(String) - Method in class org.apache.maven.plugins.checkstyle.ReportResource
- setResources(List<Resource>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setResults(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- setSeverityLevel(SeverityLevel) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setSeverityLevelFilter(SeverityLevel) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- setSourceDirectories(Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setStringOutputStream(ByteArrayOutputStream) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setSuppressionsFileExpression(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setSuppressionsLocation(String) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setTemplateDirectory(String) - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- setTestResources(List<Resource>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setTestSourceDirectories(Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- setTreeWalkerNames(List<String>) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- setVelocity(VelocityComponent) - Method in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- setXrefLocation(String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- severityLevel - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- severityLevel - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- sink - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- sink - Variable in class org.apache.maven.plugins.checkstyle.IconTool
- siteTool - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
SiteTool.
- siteTool - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- skip - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Skip entire check.
- skip - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Skip entire check.
- skipExec - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Skip Checkstyle execution will only scan the outputFile.
- sortConfiguration(List<CheckstyleReportGenerator.ConfReference>, Configuration, CheckstyleReportGenerator.ChainedItem<Configuration>, CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- sortConfiguration(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
- sourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the source directories to be used for Checkstyle.
- sourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the source directories to be used for Checkstyle.
- sourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- sourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- sourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Deprecated.
- sourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Deprecated.instead use
CheckstyleViolationCheckMojo.sourceDirectories
. For version 3.0.0, this parameter is only defined to break the build if you use it! - stringOutputStream - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- stringOutputStream - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- stringOutputStream - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- suffix(int) - Method in class org.apache.maven.plugins.checkstyle.IconTool
- suppressionsFileExpression - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
The key to be used in the properties for the suppressions file.
- suppressionsFileExpression - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The key to be used in the properties for the suppressions file.
- suppressionsFileExpression - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- suppressionsLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the suppressions XML file to use.
- suppressionsLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the suppressions XML file to use.
- suppressionsLocation - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
T
- templateDirectory - Variable in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- testResources - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the test resources to be used for Checkstyle.
- testResources - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the test resources to be used for Checkstyle.
- testResources - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- testSourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies the location of the test source directories to be used for Checkstyle.
- testSourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies the location of the test source directories to be used for Checkstyle.
- testSourceDirectories - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- testSourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Deprecated.instead use
AbstractCheckstyleReport.testSourceDirectories
. For version 3.0.0, this parameter is only defined to break the build if you use it! - testSourceDirectory - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Deprecated.instead use
CheckstyleViolationCheckMojo.testSourceDirectories
. For version 3.0.0, this parameter is only defined to break the build if you use it! - TEXT_ABBREV - Static variable in class org.apache.maven.plugins.checkstyle.IconTool
- TEXT_SIMPLE - Static variable in class org.apache.maven.plugins.checkstyle.IconTool
- TEXT_TITLE - Static variable in class org.apache.maven.plugins.checkstyle.IconTool
- treeWalkerNames - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
When using custom treeWalkers, specify their names here so the checks inside the treeWalker end up the the rule-summary.
- treeWalkerNames - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
U
- useFile - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
If
null
, the Checkstyle plugin will display violations on stdout. - useFile - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
If
null
, the Checkstyle plugin will display violations on stdout.
V
- value - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ChainedItem
- velocity - Variable in class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- velocityComponent - Variable in class org.apache.maven.plugins.checkstyle.rss.DefaultCheckstyleRssGenerator
- VelocityTemplate - Class in org.apache.maven.plugins.checkstyle.rss
-
A component to work with VelocityTemplates from within plugins.
- VelocityTemplate(VelocityComponent, String) - Constructor for class org.apache.maven.plugins.checkstyle.rss.VelocityTemplate
- violationIgnore - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Violations to ignore.
- violations - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference
- violationSeverity - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The lowest severity level that is considered a violation.
W
X
- xrefLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Location of the Xrefs to link to.
- xrefLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
AbstractCheckstyleReport.sourceDirectories
. For version 3.0.0, this parameter is only defined to break the build if you use it!