AssignmentTeacherFiles

class AssignmentTeacherFiles: Any

Provides functionality related with an Assignment's Teacher Files (for example, checking if the Teacher's submission compiles, passes the CheckStyle, and so on).

Fields

Name Description
val assignmentsRootLocation: String
val mavenizedProjectsRootLocation: String
val buildWorker: BuildWorker
val buildReportRepository: BuildReportRepository
val assignmentTestMethodRepository: AssignmentTestMethodRepository
val applicationContext: ApplicationContext

Constructors

<init>

constructor(buildWorker: BuildWorker, buildReportRepository: BuildReportRepository, assignmentTestMethodRepository: AssignmentTestMethodRepository, applicationContext: ApplicationContext)

Provides functionality related with an Assignment's Teacher Files (for example, checking if the Teacher's submission compiles, passes the CheckStyle, and so on).

Parameters

Name Description
buildWorker: BuildWorker
buildReportRepository: BuildReportRepository
assignmentTestMethodRepository: AssignmentTestMethodRepository
applicationContext: ApplicationContext

Methods

getHtmlInstructionsFragment

fun getHtmlInstructionsFragment(assignment: Assignment): String

Parameters

Name Description
assignment: Assignment

ReturnValue

Name Description
String

copyTeacherFilesTo

fun copyTeacherFilesTo(assignment: Assignment, mavenizedProjectFolder: File)

Parameters

Name Description
assignment: Assignment
mavenizedProjectFolder: File

ReturnValue

Name Description
Unit

buildPackageTree

fun buildPackageTree(packageName: String?, language: Language, hasStudentTests: Boolean): String

Builds a String with the expected project structure for an Assignment, in order to help students configure their projects.

Parameters

Name Description
packageName: String?

is a String with the Assignment's expected package name

language: Language

is a Language, identifying the programming language that is used in the Assignment

hasStudentTests: Boolean

is a Boolean indicating if the Assignement requires/allows student tests

ReturnValue

Name Description
String

a String

checkAssignmentFiles

fun checkAssignmentFiles(assignment: Assignment, principal: Principal?): List<Info>

Parameters

Name Description
assignment: Assignment
principal: Principal?

ReturnValue

Name Description
List<Info>

getProjectFolderAsFile

fun getProjectFolderAsFile(submission: Submission, wasRebuilt: Boolean): File

Parameters

Name Description
submission: Submission
wasRebuilt: Boolean

ReturnValue

Name Description
File