hudson.plugins.pmd.util.model
Class JavaProject

java.lang.Object
  hudson.plugins.pmd.util.model.AnnotationContainer
      hudson.plugins.pmd.util.model.JavaProject

All Implemented Interfaces:

AnnotationProvider, java.io.Serializable

public class JavaProject
extends AnnotationContainer

A serializable Java Bean class representing a project that has been built by Hudson.

Author:

Ulli Hafner

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hudson.plugins.pmd.util.model.AnnotationContainer

AnnotationContainer.Hierarchy

Constructor Summary

JavaProject()
Creates a new instance of JavaProject.

Method Summary

void	addModule(MavenModule module) Adds the specified module with its annotations to this project.
void	addModules(java.util.Collection<MavenModule> modules) Adds the specified modules with their annotations to this project.
java.util.List<java.lang.String>	getErrors() Returns the error messages recorded during creation of the project.
java.lang.String	getWorkspacePath() Returns the root path of the workspace files.
boolean	hasError() Returns whether a module with an error is part of this project.
void	setError(java.lang.String error) Sets the error message that denotes that why project creation has been failed.
void	setWorkspacePath(java.lang.String workspacePath) Sets the root path of the workspace files.

Methods inherited from class hudson.plugins.pmd.util.model.AnnotationContainer

addAnnotation, addAnnotations, addAnnotations, containsCategory, containsFile, containsModule, containsPackage, containsType, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getCategories, getCategory, getContainer, getFile, getFile, getFiles, getHighAnnotations, getHighPriority, getLowAnnotations, getLowPriority, getModule, getModules, getName, getNormalAnnotations, getNormalPriority, getNumberOfAnnotations, getNumberOfAnnotations, getNumberOfAnnotations, getPackage, getPackageCategoryName, getPackages, getToolTip, getType, getTypes, hasAnnotations, hasAnnotations, hasAnnotations, hasNoAnnotations, hasNoAnnotations, hasNoAnnotations, rebuildMappings, setHierarchy, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaProject

public JavaProject()

Creates a new instance of JavaProject.

Method Detail

addModule

public void addModule(MavenModule module)

Adds the specified module with its annotations to this project.

Parameters:

module - the module to add

addModules

public void addModules(java.util.Collection<MavenModule> modules)

Adds the specified modules with their annotations to this project.

Parameters:

modules - the modules to add

setWorkspacePath

public void setWorkspacePath(java.lang.String workspacePath)

Sets the root path of the workspace files.

Parameters:

workspacePath - path to workspace

getWorkspacePath

public java.lang.String getWorkspacePath()

Returns the root path of the workspace files.

Returns:

the workspace path

hasError

public boolean hasError()

Returns whether a module with an error is part of this project.

Returns:

true if at least one module has an error.

setError

public void setError(java.lang.String error)

Sets the error message that denotes that why project creation has been failed.

Parameters:

error - the new error message

getErrors

public java.util.List<java.lang.String> getErrors()

Returns the error messages recorded during creation of the project.

Returns:

the error messages recorded during creation of the project