Class CheckstyleReport
java.lang.Object
org.apache.maven.plugin.AbstractMojo
org.apache.maven.reporting.AbstractMavenReport
org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
org.apache.maven.plugins.checkstyle.CheckstyleReport
- All Implemented Interfaces:
org.apache.maven.plugin.ContextEnabled
,org.apache.maven.plugin.Mojo
,org.apache.maven.reporting.MavenMultiPageReport
,org.apache.maven.reporting.MavenReport
@Mojo(name="checkstyle",
requiresDependencyResolution=COMPILE,
threadSafe=true)
public class CheckstyleReport
extends AbstractCheckstyleReport
A reporting task that performs Checkstyle analysis and generates an HTML
report on any violations that Checkstyle finds.
-
Field Summary
Fields inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
cacheFile, checkstyleExecutor, configLocation, consoleOutput, excludes, failsOnError, headerLocation, includeResources, includes, includeTestResources, includeTestSourceDirectory, JAVA_FILES, locator, propertiesLocation, propertyExpansion, resourceExcludes, resourceIncludes, resources, skip, stringOutputStream, suppressionsFileExpression, suppressionsLocation, testResources
Fields inherited from class org.apache.maven.reporting.AbstractMavenReport
locale, mojoExecution, outputDirectory, outputFormat, outputTimestamp, project, reactorProjects, remoteProjectRepositories, repoSession, siteDirectory, siteRenderer, siteTool
Fields inherited from interface org.apache.maven.reporting.MavenReport
CATEGORY_PROJECT_INFORMATION, CATEGORY_PROJECT_REPORTS, ROLE
Fields inherited from interface org.apache.maven.plugin.Mojo
ROLE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
protected CheckstyleExecutorRequest
Create the Checkstyle executor request.private boolean
hasResources
(List<org.apache.maven.model.Resource> resources) Check if any of the resources exist.Methods inherited from class org.apache.maven.plugins.checkstyle.AbstractCheckstyleReport
executeReport, getConsoleListener, getDescription, getI18nString, getListener, getName, getProject, getReactorProjects, getSourceDirectories, getTestSourceDirectories
Methods inherited from class org.apache.maven.reporting.AbstractMavenReport
closeReport, constructXrefLocation, execute, generate, generate, getCategoryName, getInputEncoding, getLocale, getOutputDirectory, getOutputEncoding, getReportOutputDirectory, getSink, getSinkFactory, getSiteRenderer, getXrefLocation, isExternalReport, setReportOutputDirectory
Methods inherited from class org.apache.maven.plugin.AbstractMojo
getLog, getPluginContext, setLog, setPluginContext
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.maven.reporting.MavenReport
getOutputPath
-
Constructor Details
-
CheckstyleReport
public CheckstyleReport()
-
-
Method Details
-
createRequest
protected CheckstyleExecutorRequest createRequest() throws org.apache.maven.reporting.MavenReportExceptionCreate the Checkstyle executor request.- Specified by:
createRequest
in classAbstractCheckstyleReport
- Returns:
- The executor request.
- Throws:
org.apache.maven.reporting.MavenReportException
- If something goes wrong during creation.
-
getOutputName
-
canGenerateReport
public boolean canGenerateReport()- Specified by:
canGenerateReport
in interfaceorg.apache.maven.reporting.MavenReport
- Overrides:
canGenerateReport
in classorg.apache.maven.reporting.AbstractMavenReport
-
hasResources
Check if any of the resources exist.- Parameters:
resources
- The resources to check- Returns:
true
if the resource directory exist
-