Index

A B C D E F G H I J M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addCommandLineArg(String) - Method in class com.github.jgrade2.jgrade2.CLITester

Add a command line argument to the command to be run.

addGradedTestResult(GradedTestResult) - Method in class com.github.jgrade2.jgrade2.Grader

Add a GradedTestResult to the Grader.

addOutput(String) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Add output to the test result.

addOutput(String) - Method in class com.github.jgrade2.jgrade2.Grader

Add output to the Grader overall.

AFTER_DUE_DATE - Static variable in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Visible to the student only after the due date.

AFTER_PUBLISHED - Static variable in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Visible to the student only after grades have been released.

AfterGrading - Annotation Interface in com.github.jgrade2.jgrade2

Annotation for a method to run after the other @Grade methods when the jar is being run in executable mode.

B

BeforeGrading - Annotation Interface in com.github.jgrade2.jgrade2

Annotation for a method to run before the other @Grade methods when the jar is being run in executable mode.

C

CheckstyleGrader - Class in com.github.jgrade2.jgrade2

Class to assist in getting a GradedTestResult for checkstyle.

CheckstyleGrader(double, double, String, String) - Constructor for class com.github.jgrade2.jgrade2.CheckstyleGrader

Instantiate a new CheckstyleGrader.

CLIResult - Interface in com.github.jgrade2.jgrade2

For the result of interaction with a command line interface program.

CLIResult.STREAM - Enum Class in com.github.jgrade2.jgrade2

Enumeration for the different types of streams to get output for, including STDOUT and STDERR.

CLITester - Class in com.github.jgrade2.jgrade2

A class to assist in testing the main method of programs that are designed with a command line interface (as many introductory assignments are).

CLITester() - Constructor for class com.github.jgrade2.jgrade2.CLITester

com.github.jgrade2.jgrade2 - package com.github.jgrade2.jgrade2

com.github.jgrade2.jgrade2.gradedtest - package com.github.jgrade2.jgrade2.gradedtest

com.github.jgrade2.jgrade2.gradescope - package com.github.jgrade2.jgrade2.gradescope

D

DeductiveGraderStrategy - Class in com.github.jgrade2.jgrade2

Strategy to grade deductively.

DeductiveGraderStrategy(double, String) - Constructor for class com.github.jgrade2.jgrade2.DeductiveGraderStrategy

Create a new DeductiveGradingStrategy.

dynamicTestRegistered(TestIdentifier) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when a new, dynamic TestIdentifier has been registered.

E

executeProcess(ProcessBuilder) - Static method in class com.github.jgrade2.jgrade2.CLITester

Executes a process with a provided ProcessBuilder but sends no input to the program.

executeProcess(ProcessBuilder, String) - Static method in class com.github.jgrade2.jgrade2.CLITester

Execute a process provided a ProcessBuilder that has a command set to invoke the process, and a String for input to feed to the program.

executionFinished(TestIdentifier, TestExecutionResult) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when the execution of a leaf or subtree of the TestPlan has finished, regardless of the outcome.

executionSkipped(TestIdentifier, String) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when the execution of a leaf or subtree of the TestPlan has been skipped.

executionStarted(TestIdentifier) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when the execution of a leaf or subtree of the TestPlan is about to be started.

exitValue() - Method in interface com.github.jgrade2.jgrade2.CLIResult

Get the exit value of the process that was run.

F

format(Grader) - Method in class com.github.jgrade2.jgrade2.gradescope.GradescopeJsonFormatter

Formats the Grader into a JSON string.

format(Grader) - Method in interface com.github.jgrade2.jgrade2.OutputFormatter

Get the formatted output of the grader.

G

getBuilder() - Method in class com.github.jgrade2.jgrade2.CLITester

Get the ProcessBuilder that was initialized from CLITester.initCommand().

getCommand() - Method in class com.github.jgrade2.jgrade2.CLITester

Get the command that was initialized from CLITester.initCommand().

getDeductedPoints() - Method in class com.github.jgrade2.jgrade2.DeductiveGraderStrategy

Get the amount of points deducted from running this.

getErrorTypeCount() - Method in class com.github.jgrade2.jgrade2.CheckstyleGrader

Get the number of different error types encountered.

getErrorTypes() - Method in class com.github.jgrade2.jgrade2.CheckstyleGrader

Get the map of error types to their count.

getExecutionTime() - Method in class com.github.jgrade2.jgrade2.Grader

Get the execution time.

getGradedTestAnnotation(MethodSource) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when analyzing the test that finished executing.

getGradedTestResults() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Get the list of GradedTestResult.

getGradedTestResults() - Method in class com.github.jgrade2.jgrade2.Grader

Get the list of GradedTestResults.

getInvocation() - Method in class com.github.jgrade2.jgrade2.CLITester

Get the invocation for the CLI program.

getMaxScore() - Method in class com.github.jgrade2.jgrade2.Grader

Get the max potential score.

getName() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Get the name of the test.

getNumber() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Get the number of the test.

getNumFailedGradedTests() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Get the number of failed graded tests.

getNumGradedTests() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Get the count of graded tests for this listener.

getOutput() - Method in interface com.github.jgrade2.jgrade2.CLIResult

Get standard output.

getOutput() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Get the output of the test.

getOutput() - Method in class com.github.jgrade2.jgrade2.Grader

Get the output for the Grader.

getOutput(CLIResult.STREAM) - Method in interface com.github.jgrade2.jgrade2.CLIResult

Get the output for the specified stream.

getOutputByLine(CLIResult.STREAM) - Method in interface com.github.jgrade2.jgrade2.CLIResult

Get the output for the specified stream split by lines.

getPoints() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Get the points the test is worth.

getScore() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Get the score of the test.

getScore() - Method in class com.github.jgrade2.jgrade2.Grader

Get the (student) score for the Grader.

getTestMethodSource(TestIdentifier) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when analyzing the test that finished executing.

getVisibility() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Get the visibility setting of the test.

grade(List<GradedTestResult>) - Method in class com.github.jgrade2.jgrade2.DeductiveGraderStrategy

Grades the list of GradedTestResults.

grade(List<GradedTestResult>) - Method in interface com.github.jgrade2.jgrade2.GraderStrategy

Do work on the list of GradedTestResults before they get added to the overall list of tests.

Grade - Annotation Interface in com.github.jgrade2.jgrade2

Annotation for any method to grade when the jar is run as an executable.

GradedTest - Annotation Interface in com.github.jgrade2.jgrade2.gradedtest

The GradedTest annotation is primarily based off of capturing the data for a test object in the Gradescope JSON output.

GradedTestListener - Class in com.github.jgrade2.jgrade2.gradedtest

A class that extends a JUnit TestExecutionListener to check for unit test methods annotated with the GradedTest annotation.

GradedTestListener() - Constructor for class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Constructor for a new listener.

GradedTestResult - Class in com.github.jgrade2.jgrade2.gradedtest

A class for the data that models a graded test.

GradedTestResult(String, String, double, String) - Constructor for class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Create a new GradedTestResult, setting the initial score to 0.

Grader - Class in com.github.jgrade2.jgrade2

A class to encompass all of the options for grading tests.

Grader() - Constructor for class com.github.jgrade2.jgrade2.Grader

Create a new Grader.

GraderStrategy - Interface in com.github.jgrade2.jgrade2

Interface for the strategy design pattern on top of a Grader object.

GradescopeJsonException - Exception Class in com.github.jgrade2.jgrade2.gradescope

An exception for when the JSON to output to Gradescope does not match the schema it expects.

GradescopeJsonException(String) - Constructor for exception class com.github.jgrade2.jgrade2.gradescope.GradescopeJsonException

Create an instance of this exception.

GradescopeJsonFormatter - Class in com.github.jgrade2.jgrade2.gradescope

A concrete formatter for a Grader where the output it produces is the JSON a Gradescope Autograder can work with.

GradescopeJsonFormatter() - Constructor for class com.github.jgrade2.jgrade2.gradescope.GradescopeJsonFormatter

Creates an instance of the formatter.

H

hasExecutionTime() - Method in class com.github.jgrade2.jgrade2.Grader

Has an execution time.

hasGradedTestResults() - Method in class com.github.jgrade2.jgrade2.Grader

Has any GradedTestResults.

hasMaxScore() - Method in class com.github.jgrade2.jgrade2.Grader

Has a max score set.

hasOutput() - Method in class com.github.jgrade2.jgrade2.Grader

Has output for the Grader.

hasScore() - Method in class com.github.jgrade2.jgrade2.Grader

Has a score set.

HIDDEN - Static variable in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Never visible to the student.

I

initCommand() - Method in class com.github.jgrade2.jgrade2.CLITester

Initializes the command for the test (and is annotated with BeforeEach.

isFileToCheck(Path) - Static method in class com.github.jgrade2.jgrade2.CheckstyleGrader

Boolean function for whether or not a file should be included in checkstyle's run.

J

JGrade2 - Class in com.github.jgrade2.jgrade2

The class with the main entry point for JGrade.

M

main(String[]) - Static method in class com.github.jgrade2.jgrade2.JGrade2

Main entry point.

N

name() - Element in annotation interface com.github.jgrade2.jgrade2.gradedtest.GradedTest

The name of the test.

number() - Element in annotation interface com.github.jgrade2.jgrade2.gradedtest.GradedTest

The number corresponding to the test.

O

OutputFormatter - Interface in com.github.jgrade2.jgrade2

A formatter that formats data of a Grader to produce output.

P

passed() - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Determine if the test for this result was considered to have passed or not.

points() - Element in annotation interface com.github.jgrade2.jgrade2.gradedtest.GradedTest

The number of points the test is worth.

R

reportingEntryPublished(TestIdentifier, ReportEntry) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when additional test reporting data has been published for the supplied TestIdentifier.

runCommand() - Method in class com.github.jgrade2.jgrade2.CLITester

Run the command as it is currently set for this class without feeding in anything to stdin.

runCommand(String) - Method in class com.github.jgrade2.jgrade2.CLITester

Run a command with input.

runForGradedTestResult() - Method in class com.github.jgrade2.jgrade2.CheckstyleGrader

Run the graded for a GradedTestResult.

runJUnitGradedTests(Class<?>) - Method in class com.github.jgrade2.jgrade2.Grader

Runs JUnit tests and attaches a GradedTestListener to listen for all GradedTests and add the created GradedTestResults.

S

setConfig(String) - Method in class com.github.jgrade2.jgrade2.CheckstyleGrader

Set a configuration file to use for the checkstyle run.

setExecutionTime(long) - Method in class com.github.jgrade2.jgrade2.Grader

Set the execution time for the Grader.

setFloor(double) - Method in class com.github.jgrade2.jgrade2.DeductiveGraderStrategy

Set the floor to deduct to.

setGraderStrategy(GraderStrategy) - Method in class com.github.jgrade2.jgrade2.Grader

Set the strategy to use to grade.

setMaxScore(double) - Method in class com.github.jgrade2.jgrade2.Grader

Set the max potential score for the Grader.

setPassed(boolean) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Set whether or not this result passed.

setPoints(double) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Set the number of points the test is worth.

setPrettyPrint(int) - Method in class com.github.jgrade2.jgrade2.gradescope.GradescopeJsonFormatter

Sets the pretty-print for the JSON to output.

setPrintOutput(boolean) - Method in class com.github.jgrade2.jgrade2.CLITester

Set whether or not to print the captured output.

setScore(double) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Set the score for the test.

setScore(double) - Method in class com.github.jgrade2.jgrade2.Grader

Set the score (student's score) for the Grader.

setStdoutVisibility(String) - Method in class com.github.jgrade2.jgrade2.gradescope.GradescopeJsonFormatter

Sets the visibility for standard out during the run.

setVisibility(String) - Method in class com.github.jgrade2.jgrade2.gradescope.GradescopeJsonFormatter

Sets the visibility for all of the test cases.

startTimer() - Method in class com.github.jgrade2.jgrade2.Grader

Starts (or resumes) the timer for the Grader.

STDERR - Enum constant in enum class com.github.jgrade2.jgrade2.CLIResult.STREAM

Standard error.

STDOUT - Enum constant in enum class com.github.jgrade2.jgrade2.CLIResult.STREAM

Standard output.

stopTimer() - Method in class com.github.jgrade2.jgrade2.Grader

Stops the timer for the Grader.

T

testPlanExecutionFinished(TestPlan) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when the execution of the TestPlan has finished, after all tests have been executed.Currently empty and does not have any use.

testPlanExecutionStarted(TestPlan) - Method in class com.github.jgrade2.jgrade2.gradedtest.GradedTestListener

Called when the execution of the TestPlan has started, before any test has been executed.

V

valueOf(String) - Static method in enum class com.github.jgrade2.jgrade2.CLIResult.STREAM

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.github.jgrade2.jgrade2.CLIResult.STREAM

Returns an array containing the constants of this enum class, in the order they are declared.

visibility() - Element in annotation interface com.github.jgrade2.jgrade2.gradedtest.GradedTest

The visibility level of the test.

VISIBLE - Static variable in class com.github.jgrade2.jgrade2.gradedtest.GradedTestResult

Visible to the student always.

A B C D E F G H I J M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form