Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Grade

java.lang.Object

page.codeberg.friedolyn.grades.Grade

All Implemented Interfaces:

Redactable

public class Grade
extends Object
implements Redactable

Represents a student's grade of an exam, a Module or an entire degree.

Field Summary

Fields

Modifier and Type	Field	Description
final double	GRADE	The student's grade of an exam, a Module or an entire degree.

Constructor Summary

Constructors

Constructor	Description
Grade(double grade)	Constructs a new Grade object with the given grade.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)	Checks whether this Grade's value is equal to the given object's value.
double	get()
@NonNull String	toString()
@NonNull String	toStringRedacted()	Redacts the grade if the current invalid reference debug level is WARN or ERROR.

Methods inherited from class java.lang.Object

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

Field Details

GRADE

public final double GRADE

The student's grade of an exam, a Module or an entire degree. Between 0.7 and 5.0.

Constructor Details

Grade

public Grade(double grade)
      throws IllegalArgumentException

Constructs a new Grade object with the given grade.

Parameters:

grade - The grade in an exam, a Module or an entire degree. Must be between 0.7 and 5.0 (inclusive) and have at most 2 decimal places.

Throws:

IllegalArgumentException - If the grade is less than 0.7 or greater than 5.0 or has more than 2 decimal places.

Method Details

get

public double get()

Returns:

The student's grade of an exam, a Module or an entire degree. Between 0.7 and 5.0 (inclusive).

equals

public boolean equals(Object object)

Checks whether this Grade's value is equal to the given object's value.

Overrides:

equals in class Object

Parameters:

object - The object to compare this Grade object with.

Returns:

Whether the two Grade objects are equal.

toString

@NonNull
public @NonNull String toString()

Specified by:

toString in interface Redactable

Overrides:

toString in class Object

Returns:

A string representation of this Grade object.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Redacts the grade if the current

invalid reference

debug level

is WARN or ERROR.

Specified by:

toStringRedacted in interface Redactable

Returns:

A redacted string representation of this Grade object.