CheckstyleReportListener (Apache Maven Checkstyle Plugin 2.11-SNAPSHOT API)

; Mon, 11 Nov 2013 22:43:06 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r886226 [7/44] - in /websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT: ./ apidocs/ apidocs/org/ apidocs/org/apache/ apidocs/org/apache/maven/ apidocs/org/apache/maven/plugin/ apidocs/org/apache/maven/... Date: Mon, 11 Nov 2013 22:42:54 -0000 To: commits@maven.apache.org From: bimargulies@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20131111224306.4E3B42388C1C@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReportListener.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReportListener.html (added) +++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReportListener.html Mon Nov 11 22:42:50 2013 @@ -0,0 +1,500 @@ + + + + + +CheckstyleReportListener (Apache Maven Checkstyle Plugin 2.11-SNAPSHOT API) + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
- +
  - org.apache.maven.plugin.checkstyle.CheckstyleReportListener
  +
+

+
+
All Implemented Interfaces:
+
AuditListener, Configurable, Contextualizable, EventListener
+
+
+
+
```
public class CheckstyleReportListener
+extends AutomaticBean
+implements AuditListener
```
+
Listener in charge of receiving events from the Checker.
+
Version:
+
$Id: CheckstyleReportListener.java 1231408 2012-01-13 23:56:46Z rfscholte $
+
Author:
+
Emmanuel Venisse, Vincent Siveton
+

+ +

+ + +

Constructor Summary

+ + + + + + + + + + + + + + +

Constructors
Constructor and Description
`CheckstyleReportListener(Configuration configuration)`
`CheckstyleReportListener(File sourceDirectory)`
`CheckstyleReportListener(File sourceDirectory, + Configuration configuration)`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`void`	`addError(AuditEvent event)`
`void`	`addException(AuditEvent event, + Throwable throwable)`
`void`	`addSourceDirectory(File sourceDirectory)`
`void`	`auditFinished(AuditEvent event)`
`void`	`auditStarted(AuditEvent event)`
`void`	`fileFinished(AuditEvent event)`
`void`	`fileStarted(AuditEvent event)`
`Configuration`	`getCheckstyleConfiguration()`
`CheckstyleResults`	`getResults()`
`SeverityLevel`	`getSeverityLevelFilter()`
`void`	`setCheckstyleConfiguration(Configuration checkstyleConfiguration)`
`void`	`setResults(CheckstyleResults results)`
`void`	`setSeverityLevelFilter(SeverityLevel severityLevel)`

+ + +
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
+configure, contextualize, finishLocalSetup, getConfiguration< /a>, setupChild

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +
- + + +
  Constructor Detail
  + + + +
  - +
    CheckstyleReportListener
    +
```
public CheckstyleReportListener(File sourceDirectory)
```
    +
    Parameters:
    sourceDirectory - assume that is sourceDirectory is a not null directory and exists
    +
  + + + +
  - +
    CheckstyleReportListener
    +
```
public CheckstyleReportListener(File sourceDirectory,
+                        Configuration configuration)
```
    +
    Parameters:
    sourceDirectory - assume that is sourceDirectory is a not null directory and exists
    configuration - checkstyle configuration
    Since:
    +
    2.5
    +
  + + + +
  - +
    CheckstyleReportListener
    +
```
public CheckstyleReportListener(Configuration configuration)
```
    +
    Parameters:
    configuration - checkstyle configuration
    Since:
    +
    2.5
    +
  +
+ +
- + + +
  Method Detail
  + + + +
  - +
    addSourceDirectory
    +
```
public void addSourceDirectory(File sourceDirectory)
```
    +
    Parameters:
    sourceDirectory - assume that is sourceDirectory is a not null directory and exists
    +
  + + + +
  - +
    setSeverityLevelFilter
    +
```
public void setSeverityLevelFilter(SeverityLevel severityLevel)
```
    +
    Parameters:
    severityLevel -
    +
  + + + +
  - +
    getSeverityLevelFilter
    +
```
public SeverityLevel getSeverityLevelFilter()
```
    +
    Returns:
    +
  + + + +
  - +
    auditStarted
    +
```
public void auditStarted(AuditEvent event)
```
    +
    +
    Specified by:
    +
    auditStarted in interface AuditListener
    +
    +
  + + + +
  - +
    auditFinished
    +
```
public void auditFinished(AuditEvent event)
```
    +
    +
    Specified by:
    +
    auditFinished in interface AuditListener
    +
    +
  + + + +
  - +
    fileStarted
    +
```
public void fileStarted(AuditEvent event)
```
    +
    +
    Specified by:
    +
    fileStarted in interface AuditListener
    +
    +
  + + + +
  - +
    fileFinished
    +
```
public void fileFinished(AuditEvent event)
```
    +
    +
    Specified by:
    +
    fileFinished in interface AuditListener
    +
    +
  + + + +
  - +
    addError
    +
```
public void addError(AuditEvent event)
```
    +
    +
    Specified by:
    +
    addError in interface AuditListener
    +
    +
  + + + +
  - +
    addException
    +
```
public void addException(AuditEvent event,
+                Throwable throwable)
```
    +
    +
    Specified by:
    +
    addException in interface AuditListener
    +
    +
  + + + +
  - +
    getResults
    +
```
public CheckstyleResults getResults()
```
    +
    Returns:
    +
  + + + +
  - +
    setResults
    +
```
public void setResults(CheckstyleResults results)
```
    +
    Parameters:
    results -
    +
  + + + +
  - +
    getCheckstyleConfiguration
    +
```
public Configuration getCheckstyleConfiguration()
```
    +
    Since:
    +
    2.5
    +
  + + + +
  - +
    setCheckstyleConfiguration
    +
```
public void setCheckstyleConfiguration(Configuration checkstyleConfiguration)
```
    +
    Since:
    +
    2.5
    +
  +
+

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + \ No newline at end of file Propchange: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReportListener.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleReportListener.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleResults.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleResults.html (added) +++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleResults.html Mon Nov 11 22:42:50 2013 @@ -0,0 +1,384 @@ + + + + + +CheckstyleResults (Apache Maven Checkstyle Plugin 2.11-SNAPSHOT API) + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.maven.plugin.checkstyle.CheckstyleResults
+

+
+
+
```
public class CheckstyleResults
+extends Object
```
+
Object holding the references to the CheckstyleResults.
+
Version:
+
$Id: CheckstyleResults.java 942969 2010-05-11 00:32:30Z hboutemy $
+
Author:
+
Joakim Erdfelt
+

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
CheckstyleResults()
+

Constructors
Constructor and Description
`CheckstyleResults()`

+ +

+ + +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`Configuration`	`getConfiguration()`
`int`	`getFileCount()`
`Map<String,List<AuditEvent>>`	`getFiles()`
`List<AuditEvent>`	`getFileViolations(String file)`
`long`	`getSeverityCount(List<AuditEvent> violations, + SeverityLevel level)`
`long`	`getSeverityCount(SeverityLevel level)`
`long`	`getSeverityCount(String file, + SeverityLevel level)`
`void`	`setConfiguration(Configuration configuration)`
`void`	`setFiles(Map<String,List<AuditEvent>> files)`
`void`	`setFileViolations(String file, + List<AuditEvent> violations)`

+ + +
Methods inherited from class java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

+ +

+ + +
Constructor Detail
+ + + +
- +
  CheckstyleResults
  +
```
public CheckstyleResults()
```
  +
+

+ +

+ + +

Method Detail

+ + + +

getFileViolations

public List<AuditEvent> getFileViolations(String file)

+ + + +

setFileViolations

public void setFileViolations(String file,
+                     List<AuditEvent> violations)

+ + + +

getFiles

public Map<String,List<AuditEvent>> getFiles()

+ + + +

setFiles

public void setFiles(Map<String,List<AuditEvent>> files)

+ + + +

+
getFileCount
+
```
public int getFileCount()
```
+

+ + + +

getSeverityCount

public long getSeverityCount(SeverityLevel level)

+ + + +

getSeverityCount

public long getSeverityCount(String file,
+                    SeverityLevel level)

+ + + +

getSeverityCount

public long getSeverityCount(List<AuditEvent> violations,
+                    SeverityLevel level)

+ + + +

getConfiguration

public Configuration getConfiguration()

+ + + +

setConfiguration

public void setConfiguration(Configuration configuration)

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

+ + \ No newline at end of file Propchange: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleResults.html ------------------------------------------------------------------------------ svn:eol-style = native Propchange: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleResults.html ------------------------------------------------------------------------------ svn:mime-type = text/html Added: websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html (added) +++ websites/production/maven/content/plugins-archives/maven-checkstyle-plugin-2.11-SNAPSHOT/apidocs/org/apache/maven/plugin/checkstyle/CheckstyleViolationCheckMojo.html Mon Nov 11 22:42:50 2013 @@ -0,0 +1,371 @@ + + + + + +CheckstyleViolationCheckMojo (Apache Maven Checkstyle Plugin 2.11-SNAPSHOT API) + + + + + + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ + + +

java.lang.Object
+
- org.apache.maven.plugin.AbstractMojo
- +
  - org.apache.maven.plugin.checkstyle.CheckstyleViolationCheckMojo
  +
+

+
+
All Implemented Interfaces:
+
ContextEnabled, Mojo
+
+
+
+
```
@Mojo(name="check",
+      defaultPhase=VERIFY,
+      requiresDependencyResolution=TEST,
+      threadSafe=true)
+public class CheckstyleViolationCheckMojo
+extends AbstractMojo
```
+
Performs Checkstyle analysis and outputs violations or a count of violations to the console, potentially failing the build. + It can also be configured to re-use an earlier analysis.
+
Version:
+
$Id: CheckstyleViolationCheckMojo.java 1540869 2013-11-11 22:23:27Z bimargulies $
+
Author:
+
Joakim Erdfelt
+

+ +

+ + +

Field Summary

+ + + + + + + + + + + + + + + + + + +

Fields
Modifier and Type	Field and Description
`protected CheckstyleExecutor`	`checkstyleExecutor`
`protected MavenProject`	`project` + The Maven Project Object. +
`protected List<Resource>`	`resources` + Specifies the location of the resources to be used for Checkstyle. +

+ + +
Fields inherited from interface org.apache.maven.plugin.Mojo
+ROLE

+ +

+ + +
Constructor Summary
+ + + + + + + + +
Constructors
Constructor and Description
CheckstyleViolationCheckMojo()
+

Constructors
Constructor and Description
`CheckstyleViolationCheckMojo()`

+ +

+ + +
Method Summary
+ + + + + + + + + + +
Methods
Modifier and Type Method and Description
void execute()
+
- + + +
  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
Modifier and Type	Method and Description
`void`	`execute()`

+ +

+ + +

Field Detail

+ + + +

resources

@Parameter(defaultValue="${project.resources}",
+           readonly=true)
+protected List<Resource> resources

Specifies the location of the resources to be used for Checkstyle.

Since:: 2.11

+ + + +

checkstyleExecutor

@Component(role=CheckstyleExecutor.class,
+           hint="default")
+protected CheckstyleExecutor checkstyleExecutor

Since:: 2.5

+ + + +

project

@Component
+protected MavenProject project

The Maven Project Object.

+ +

+ + +
Constructor Detail
+ + + +
- +
  CheckstyleViolationCheckMojo
  +
```
public CheckstyleViolationCheckMojo()
```
  +
+

+ +

+ + +

Method Detail

+ + + +

execute

public void execute()
+             throws MojoExecutionException,
+                    MojoFailureException

Throws:: MojoExecutionException; MojoFailureException

+ + +

+ + + + +

Prev Class
Next Class

Frames
No Frames

All Classes

+ +

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

+ + +

+ +

Class CheckstyleReportListener

Constructor Summary

Method Summary

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

Methods inherited from class java.lang.Object

Constructor Detail

CheckstyleReportListener

CheckstyleReportListener

CheckstyleReportListener

Method Detail

addSourceDirectory

setSeverityLevelFilter

getSeverityLevelFilter

auditStarted

auditFinished

fileStarted

fileFinished

addError

addException

getResults

setResults

getCheckstyleConfiguration

setCheckstyleConfiguration

Class CheckstyleResults

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CheckstyleResults

Method Detail

getFileViolations

setFileViolations

getFiles

setFiles

getFileCount

getSeverityCount

getSeverityCount

getSeverityCount

getConfiguration

setConfiguration

Class CheckstyleViolationCheckMojo

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

Constructor Summary

Method Summary

Methods inherited from class org.apache.maven.plugin.AbstractMojo

Methods inherited from class java.lang.Object

Field Detail

resources

checkstyleExecutor

project

Constructor Detail

CheckstyleViolationCheckMojo

Method Detail

execute