hudson.plugins.checkstyle.parser
Class CheckStyleParser

java.lang.Object
  hudson.plugins.checkstyle.util.AbstractAnnotationParser
      hudson.plugins.checkstyle.parser.CheckStyleParser

All Implemented Interfaces:

AnnotationParser, java.io.Serializable

public class CheckStyleParser
extends AbstractAnnotationParser

A parser for Checkstyle XML files.

Author:

Ulli Hafner

See Also:

Serialized Form

Constructor Summary

CheckStyleParser()
Creates a new instance of CheckStyleParser.

CheckStyleParser(java.lang.String defaultEncoding)
Creates a new instance of CheckStyleParser.

Method Summary

java.util.Collection<FileAnnotation>

parse(java.io.InputStream file, java.lang.String moduleName) Returns the annotations found in the specified file.

Methods inherited from class hudson.plugins.checkstyle.util.AbstractAnnotationParser

createContextHashCode, getDefaultEncoding, parse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CheckStyleParser

public CheckStyleParser()

Creates a new instance of CheckStyleParser.

CheckStyleParser

public CheckStyleParser(java.lang.String defaultEncoding)

Creates a new instance of CheckStyleParser.

Parameters:

defaultEncoding - the default encoding to be used when reading and parsing files

Method Detail

parse

public java.util.Collection<FileAnnotation> parse(java.io.InputStream file,
                                                  java.lang.String moduleName)
                                           throws java.lang.reflect.InvocationTargetException

Returns the annotations found in the specified file.

Specified by:

parse in class AbstractAnnotationParser

Parameters:

file - the file to parse

moduleName - name of the maven module

Returns:

the found annotations

Throws:

java.lang.reflect.InvocationTargetException - if the file could not be parsed (wrap your exception in this exception)