Package com.spertus.jacquard.syntaxgrader

Class MethodModifierGrader

java.lang.Object

com.spertus.jacquard.common.Grader

com.spertus.jacquard.syntaxgrader.SyntaxGrader

com.spertus.jacquard.syntaxgrader.SyntaxCheckGrader

com.spertus.jacquard.syntaxgrader.MethodModifierGrader

public final class MethodModifierGrader
extends SyntaxCheckGrader

Checks whether the correct modifiers are used for methods (instance and static). For example, this could be used to verify that certain methods are declared public or static.

Field Summary

Fields inherited from class com.spertus.jacquard.syntaxgrader.SyntaxCheckGrader

adapter, maxScorePerInstance

Constructor Summary

Constructors

Constructor	Description
MethodModifierGrader(double maxScorePerInstance, List<String> varNames, List<com.github.javaparser.ast.Modifier> requiredModifiers, List<com.github.javaparser.ast.Modifier> optionalModifiers, boolean penalizeMissingMethods)	Creates a method modifier checker with a default name.
MethodModifierGrader(String name, double maxScorePerInstance, List<String> methodNames, List<com.github.javaparser.ast.Modifier> requiredModifiers, List<com.github.javaparser.ast.Modifier> optionalModifiers, boolean penalizeMissingMethods)	Creates a method modifier grader.

Method Summary

Modifier and Type	Method	Description
void	finalizeResults(List<Result> results)	Adds any results that cannot be computed until all visits are complete.
void	initialize()	Performs any setup before a call to SyntaxCheckGrader.grade(CompilationUnit).

Methods inherited from class com.spertus.jacquard.syntaxgrader.SyntaxCheckGrader

grade, makeFailingResult, makeSuccessResult

Methods inherited from class com.spertus.jacquard.syntaxgrader.SyntaxGrader

getCallableSingleTarget

Methods inherited from class com.spertus.jacquard.common.Grader

getCallableMultiTarget, grade, grade, gradeAll, makeExceptionResult, makeExceptionResultList, makeFailureResult, makeFailureResultList, makePartialCreditResult, makeSuccessResult, makeSuccessResultList

Methods inherited from class java.lang.Object

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

Constructor Details

MethodModifierGrader

public MethodModifierGrader(String name,
 double maxScorePerInstance,
 List<String> methodNames,
 List<com.github.javaparser.ast.Modifier> requiredModifiers,
 List<com.github.javaparser.ast.Modifier> optionalModifiers,
 boolean penalizeMissingMethods)

Creates a method modifier grader. If penalizeMissingMethods is true and a method is not found, a Result will be created with a score of 0 and a maximum score of maxScorePerInstance. Otherwise, no Result will be created for missing methods.

Parameters:

name - the name, which is used in the Result

maxScorePerInstance - the maximum score for each method

methodNames - the names of the methods to check

requiredModifiers - modifiers that must be used on each method

optionalModifiers - modifiers that may be used on methods

penalizeMissingMethods - whether to apply a penalty to missing methods

MethodModifierGrader

public MethodModifierGrader(double maxScorePerInstance,
 List<String> varNames,
 List<com.github.javaparser.ast.Modifier> requiredModifiers,
 List<com.github.javaparser.ast.Modifier> optionalModifiers,
 boolean penalizeMissingMethods)

Creates a method modifier checker with a default name. If penalizeMissingMethods is true and a method is not found, a Result will be created with a score of 0 and a maximum score of maxScorePerInstance. Otherwise, no Result will be created for missing methods.

Parameters:

maxScorePerInstance - the maximum score for each method

varNames - the names of the methods to check

requiredModifiers - modifiers that must be used on each method

optionalModifiers - modifiers that may be used on methods

penalizeMissingMethods - whether to apply a penalty to missing methods

Method Details

initialize

public void initialize()

Description copied from class: SyntaxCheckGrader

Performs any setup before a call to SyntaxCheckGrader.grade(CompilationUnit).

Overrides:

initialize in class SyntaxCheckGrader

finalizeResults

public void finalizeResults(List<Result> results)

Description copied from class: SyntaxCheckGrader

Adds any results that cannot be computed until all visits are complete.

Overrides:

finalizeResults in class SyntaxCheckGrader

Parameters:

results - the list of results, which may be mutated by this call