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
- append(StringBuilder, String, int) - Method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
Append a description to the buffer by respecting the indentSize and lineLength parameters.
- 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
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.CheckstyleReportRenderer.ConfReference
- category - Variable in class org.apache.maven.plugins.checkstyle.Violation
- ChainedItem(T, CheckstyleReportRenderer.ChainedItem<T>) - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.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_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.CheckstyleReportRenderer
- 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 Class in org.apache.maven.plugins.checkstyle.exec
- CheckstyleExecutorException() - Constructor for exception class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorException(String) - Constructor for exception class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorException(String, Throwable) - Constructor for exception class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- CheckstyleExecutorException(Throwable) - Constructor for exception class 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
- CheckstyleReportRenderer - Class in org.apache.maven.plugins.checkstyle
-
Generate a report based on CheckstyleResults.
- CheckstyleReportRenderer(Sink, I18N, Locale, MavenProject, SiteTool, String, String, String, List<File>, boolean, boolean, boolean, CheckstyleResults) - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- CheckstyleReportRenderer.ChainedItem<T> - Class in org.apache.maven.plugins.checkstyle
- CheckstyleReportRenderer.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
- checkstyleRules - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
By using this property, you can specify the whole Checkstyle rules inline directly inside this pom.
- 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.
- checkstyleRulesHeader - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
The header to use for the inline configuration.
- checkstyleRulesHeader - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The header to use for the inline configuration.
- 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
- column - Variable in class org.apache.maven.plugins.checkstyle.Violation
- compareTo(CheckstyleReportRenderer.ConfReference) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.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.CheckstyleReportRenderer.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, CheckstyleReportRenderer.ChainedItem<Configuration>, long, int) - Constructor for class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.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
- count - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.ConfReference
- countViolations(List<Violation>) - 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
- DEFAULT_CONFIG_LOCATION - Static variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- DEFAULT_CONFIG_LOCATION - Static variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- DEFAULT_LINE_LENGTH - Static variable in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- DefaultCheckstyleExecutor - Class in org.apache.maven.plugins.checkstyle.exec
- DefaultCheckstyleExecutor() - Constructor for class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- defaultLogger - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- delegates - Variable in class org.apache.maven.plugins.checkstyle.CompositeAuditListener
- detail - Variable in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
If
true
, display all settable properties for each goal. - determineRelativePath(File) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
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.CheckstyleReportRenderer
- 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.CheckstyleReportRenderer
- 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.CheckstyleReportRenderer
- encoding - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- equals(Object) - Method in class org.apache.maven.plugins.checkstyle.Violation
- events - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- excludeGeneratedSources - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Specifies whether generated source files should be excluded from Checkstyle.
- excludeGeneratedSources - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Specifies whether generated source files should be excluded from Checkstyle.
- 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
- execute() - Method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- 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
- 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
- file - Variable in class org.apache.maven.plugins.checkstyle.Violation
-
The absolute path of the file containing the violation
- 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
- filterBuildTarget(List<String>) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- filterBuildTarget(List<String>) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- findNamedChild(Node, String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- findSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- finishLocalSetup() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
G
- getCacheFile() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getCategory() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the category of the current violation.
- 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.
- 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.CheckstyleReportRenderer
-
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.
- getColumn() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the column in which the violation occurred, if available.
- getConfigAttribute(Configuration, CheckstyleReportRenderer.ChainedItem<Configuration>, String, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
-
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
- getDescription(Locale) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getEffectiveXrefLocation(List<AuditEvent>) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- getEncoding() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getExcludes() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getFile() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the absolute file path to the checked file.
- 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
- getI18nString(String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- getI18nString(Locale, String) - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- getIncludes() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns the includes parameter.
- getIndentLevel(String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
Gets the indentation level of the specified line.
- getLicenseArtifacts() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns a list of license artifacts, which may contain the license.
- getLine() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the line in the checked file on which the violation occurred.
- 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
- getMessage() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the message produced by checkstyle for the current violation.
- 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
- 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.AbstractCheckstyleReport
- 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
- getPropertyFromExpression(String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- getReactorProjects() - Method in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- 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
- getResources() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- getResults() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- getRuleName() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the name of the rule which led to the current violation.
- getSeverity() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the severity of the current violation.
- 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
- getSeverityLevelFilter() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- getSingleChild(Node, String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- getSource() - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Returns the fully qualified class name of the checker rule.
- 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
- 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.CheckstyleReportRenderer
- getValue(Node, String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- getViolations(XmlPullParser) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- goal - Variable in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
The name of the goal for which to show help.
H
- hashCode() - Method in class org.apache.maven.plugins.checkstyle.Violation
- 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
- HelpMojo - Class in org.apache.maven.plugins.maven_checkstyle_plugin
-
Display help information on maven-checkstyle-plugin.
Callmvn checkstyle:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details. - HelpMojo() - Constructor for class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
I
- i18n - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Internationalization component
- i18n - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- iconSeverity(String, int) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
-
Render an icon of given level with associated text.
- ignore(List<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
- indentSize - Variable in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
The number of spaces per indentation level, should be positive.
- inputEncoding - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The file encoding to use when reading the source files.
- 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
- 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
- isNotEmpty(String) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- isOmitIgnoredModules() - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
-
Returns true if ignored modules (modules with severity 'ignore') should be omitted.
- isTestSource(String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- 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(Map<String, ResourceLoader>) - Constructor for class org.apache.maven.plugins.checkstyle.resource.LicenseResourceManager
- line - Variable in class org.apache.maven.plugins.checkstyle.Violation
- lineLength - Variable in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
The maximum length of a display line, should be positive.
- linkXRef - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Link the violation line numbers to the (Test) Source XRef.
- listener - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- locale - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- locator - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- locator - Variable in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- log(String, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- LOGGER - Static variable in class org.apache.maven.plugins.checkstyle.resource.LicenseResourceManager
- logViolationCountToConsole - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Output the detected violation count to the console.
- 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.CheckstyleReportRenderer
-
Check if a violation matches a rule.
- maxAllowedViolations - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The maximum number of allowed violations.
- message - Variable in class org.apache.maven.plugins.checkstyle.Violation
N
- NO_COLUMN - Static variable in class org.apache.maven.plugins.checkstyle.Violation
-
Indicates that a column is not set.
- NO_TEXT - Static variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
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.maven_checkstyle_plugin - package org.apache.maven.plugins.maven_checkstyle_plugin
- 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.CheckstyleReportRenderer.ChainedItem
- parentConfiguration - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.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_HELP_PATH - Static variable in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- prepareCheckstylePaths(CheckstyleExecutorRequest, MavenProject, List<String>, List<String>, Collection<File>, Collection<File>) - Method in class org.apache.maven.plugins.checkstyle.exec.DefaultCheckstyleExecutor
- printViolations(List<Violation>) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
- project - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- 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.exec.CheckstyleExecutorRequest
- renderBody() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- renderDetailsSection() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- renderFileEvents(List<AuditEvent>, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- renderFilesSummarySection() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- renderRuleRow(CheckstyleReportRenderer.ConfReference, CheckstyleResults, String) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
-
Create a summary for one Checkstyle rule.
- renderRulesSummarySection() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
-
Create the rules summary section of the report.
- renderSeveritySummarySection() - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- repeat(String, int) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
Repeat a String
n
times to form a new string. - 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
- 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.CheckstyleReportRenderer
- 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
- ruleName - Variable in class org.apache.maven.plugins.checkstyle.Violation
- ruleset - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- rulesFiles - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Dump file for inlined Checkstyle rules.
- 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 class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorException
- session - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
- 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
- setCheckstyleConfiguration(Configuration) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- setColumn(String) - Method in class org.apache.maven.plugins.checkstyle.Violation
-
Sets the column value for this violation to the given string value.
- 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
- 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
- setOmitIgnoredModules(boolean) - Method in class org.apache.maven.plugins.checkstyle.exec.CheckstyleExecutorRequest
- 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
- 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
- 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
- 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.CheckstyleReportRenderer
- severity - Variable in class org.apache.maven.plugins.checkstyle.Violation
- severityLevel - Variable in class org.apache.maven.plugins.checkstyle.exec.CheckstyleCheckerListener
- siteTool - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- 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<CheckstyleReportRenderer.ConfReference>, Configuration, CheckstyleReportRenderer.ChainedItem<Configuration>, CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- sortConfiguration(CheckstyleResults) - Method in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- source - Variable in class org.apache.maven.plugins.checkstyle.Violation
-
The full qualified class name of the checkstyle rule
- 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
- 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
- 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.CheckstyleReportRenderer
- 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.CheckstyleReportRenderer
- TEXT_SIMPLE - Static variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- TEXT_TITLE - Static variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- toLines(String, int, int, int) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
Splits the specified text into lines of convenient display length.
- toLines(List<String>, String, int, int) - Static method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
-
Adds the specified line to the output sequence, performing line wrapping if necessary.
- toString() - Method in class org.apache.maven.plugins.checkstyle.Violation
- 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.CheckstyleReportRenderer
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.CheckstyleReportRenderer.ChainedItem
- Violation - Class in org.apache.maven.plugins.checkstyle
-
Holds data about a single violation and represents the violation itself.
- Violation(String, String, String, String, String, String, String) - Constructor for class org.apache.maven.plugins.checkstyle.Violation
-
Creates a violation instance without a column set.
- violationIgnore - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
Violations to ignore.
- violations - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.ConfReference
- violationSeverity - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleViolationCheckMojo
-
The lowest severity level that is considered a violation.
W
- writeGoal(StringBuilder, String, Element) - Method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
- writeParameter(StringBuilder, Node, Node) - Method in class org.apache.maven.plugins.maven_checkstyle_plugin.HelpMojo
X
- xrefLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Location where Source XRef is generated for this project.
- xrefLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
- xrefTestLocation - Variable in class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
-
Location where Test Source XRef is generated for this project.
- xrefTestLocation - Variable in class org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
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!