Package de.hsh.graja.core

Class ModuleRunner

java.lang.Object

de.hsh.graja.core.ModuleRunner

Direct Known Subclasses:

CheckstyleModuleRunner, CompileModuleRunner, HumanModuleRunner, JunitModuleRunner, PmdModuleRunner

public abstract class ModuleRunner
extends Object

A ModuleRunner executes a module such as JUnit or PMD. It takes a ModuleRunnerInput object as input and creates a ModuleRunnerResult object as output. This as an abstract class that must be inherited by concrete implementations. For a detailed documentation of the role of module runners in the context of the grading process see javadocs of class Graja.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModuleRunner(ModuleConfiguration moduleCfg)	Constructor stores ModuleConfiguration

Method Summary

Modifier and Type	Method	Description
ModuleConfiguration	getModuleConfiguration()
abstract ModuleRunnerResult	run(ModuleRunnerInput mri, Map<String,ModuleRunnerResult> previousModuleResults)	This method executes the module runner.

Methods inherited from class java.lang.Object

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

Constructor Details

ModuleRunner

protected ModuleRunner(ModuleConfiguration moduleCfg)

Constructor stores ModuleConfiguration

Parameters:

moduleCfg - the configuration of the module

Method Details

getModuleConfiguration

public ModuleConfiguration getModuleConfiguration()

Returns:

the module configuration

run

public abstract ModuleRunnerResult run(ModuleRunnerInput mri,
 Map<String,ModuleRunnerResult> previousModuleResults)

This method executes the module runner. It must be implemented by subclasses.

Parameters:

mri - the input data for the runner

previousModuleResults - output of previous modules serves as input for this module

Returns:

the result of the module execution