de.firemage.autograder.core.Problem Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of autograder-core Show documentation

Core checks of the autograder

There is a newer version: 0.6.1

package de.firemage.autograder.core;

import de.firemage.autograder.api.AbstractProblem;
import de.firemage.autograder.api.Translatable;
import de.firemage.autograder.core.check.Check;

import java.util.Optional;

/**
 * Contains the default implementation of most {@link AbstractProblem} methods.
 */
public abstract class Problem implements AbstractProblem {

    private final Check check;

    private final CodePosition position;

    private final Translatable explanation;

    private final ProblemType problemType;

    protected Problem(Check check, CodePosition position, Translatable explanation, ProblemType problemType) {
        this.check = check;
        this.position = position;
        this.explanation = explanation;
        this.problemType = problemType;
    }

    @Override
    public String getDisplayLocation() {
        // TODO
        if (this.position.startLine() == this.position.endLine()) {
            return this.position.file() + ":" + this.position.startLine();
        } else {
            return this.position.file() + ":" + this.position.startLine() + "-" + this.position.endLine();
        }
    }

    public Check getCheck() {
        return check;
    }

    @Override
    public CodePosition getPosition() {
        return position;
    }

    @Override
    public Translatable getExplanation() {
        return explanation;
    }

    @Override
    public String getCheckName() {
        return this.check.getClass().getSimpleName();
    }

    @Override
    public Translatable getLinterName() {
        return this.check.getLinter();
    }

    @Override
    public String getType() {
        return this.problemType.toString();
    }

    @Override
    public Optional getMaximumProblemsForCheck() {
        return this.getCheck().maximumProblems();
    }

    public ProblemType getProblemType() {
        return problemType;
    }
}