hudson.plugins.pmd.util.model
Class MavenModule

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

All Implemented Interfaces:

AnnotationProvider, java.io.Serializable, java.lang.Comparable<AnnotationContainer>

public class MavenModule
extends AnnotationContainer

A serializable Java Bean class representing a maven module.

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

MavenModule()
Creates a new instance of MavenModule.

MavenModule(java.lang.String moduleName)
Creates a new instance of MavenModule.

Method Summary

java.lang.String	getError() Returns the error message for this module.
boolean	hasError() Return whether this module has an error message stored.
void	setError(java.lang.String error) Sets an error message that denotes that the creation of the module has been failed.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MavenModule

public MavenModule()

Creates a new instance of MavenModule. File handling is performed in this class since the files are already mapped in the modules of this project.

MavenModule

public MavenModule(java.lang.String moduleName)

Creates a new instance of MavenModule.

Parameters:

moduleName - name of the module

Method Detail

setError

public void setError(java.lang.String error)

Sets an error message that denotes that the creation of the module has been failed.

Parameters:

error - the error message

hasError

public boolean hasError()

Return whether this module has an error message stored.

Returns:

true if this module has an error message stored.

getError

public java.lang.String getError()

Returns the error message for this module.

Returns:

the error message for this module