hudson.plugins.checkstyle.util
Interface AnnotationParser

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CheckStyleParser

public interface AnnotationParser
extends java.io.Serializable

A parser for annotations.

Author:

Ulli Hafner

Method Summary

java.lang.String	getName() Returns the name of this parser.
MavenModule	parse(java.io.InputStream file, java.lang.String moduleName) Returns the annotations found in the specified file.

Method Detail

parse

MavenModule parse(java.io.InputStream file,
                  java.lang.String moduleName)
                  throws java.lang.reflect.InvocationTargetException

Returns the annotations found in the specified file.

Parameters:

file - the file to parse

moduleName - name of the maven module

Returns:

the parsed result (stored in the module instance)

Throws:

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

getName

java.lang.String getName()

Returns the name of this parser.

Returns:

the name of this parser