Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Module

java.lang.Object

page.codeberg.friedolyn.grades.Module

All Implemented Interfaces:

Redactable

public class Module
extends Object
implements Redactable

Represents a module of a university course.

Field Summary

Fields

Modifier and Type	Field	Description
private String	code	Uniquely identifies the module among all modules of the university, e.g.
private ECTS	ects	The number of ECTS credits the module is worth.
private final @NonNull ArrayList<Exam>	EXAMS	The exams that are part of the module and that have already been entered into the Friedolin system.
private Grade	grade	The total grade of the module, an average of the EXAMS that are part of the module.
private Semester	semester	When the module took place.
private Exam.ExamStatus	status	Whether the module is finished and, if so, whether successfully or not.
private String	title	The human-readable name of the module, e.g.

Constructor Summary

Constructors

Constructor	Description
Module()

Method Summary

Modifier and Type	Method	Description
void	addExam(@NonNull Exam exam)	Inserts a new Exam at the end of the EXAMS list.
void	addExams(@NonNull ArrayList<Exam> exams)	Inserts new Exams at the end of the EXAMS list, in the order they are specified.
void	addExams(@NonNull Exam... exams)	Inserts new Exams at the end of the EXAMS list, in the order they are specified.
@NonNull Optional<String>	getCode()
@NonNull Optional<ECTS>	getECTS()
@NonNull ArrayList<Exam>	getExams()
@NonNull Optional<Grade>	getGrade()
@NonNull Optional<Semester>	getSemester()
@NonNull Optional<Exam.ExamStatus>	getStatus()
@NonNull Optional<String>	getTitle()
@NonNull Exam	removeExam(int index)	Removes the Exam at the specified position in the exams list.
boolean	removeExam(@NonNull Exam exam)	Removes the first occurrence of the specified Exam from the EXAMS list, if it is present.
@NonNull ArrayList<Exam>	removeExams(int... indices)	Removes the Exams at the specified positions in the exams list.
boolean	removeExams(@NonNull Exam... exams)	Removes the specified Exams from the EXAMS list, if they are present.
void	resetExams()	Removes all Exams from the EXAMS list.
void	setCode(@NonNull String code)	Updates the code of the module, which uniquely identifies the module among all modules of the university.
void	setECTS(@NonNull ECTS ects)	Updates the ects of the module, the number of ECTS credits the module is worth.
void	setGrade(@NonNull Grade grade)	Updates the grade of the module, the total grade of the module, an average of the EXAMS that are part of the module.
void	setSemester(@NonNull Semester semester)	Updates the semester in which the module took place.
void	setStatus(Exam.ExamStatus status)	Updates the status of the module, whether the module is finished and, if so, whether successfully or not.
void	setTitle(@NonNull String title)	Updates the title of the module, the human-readable name of the module.
@NonNull String	toString()
@NonNull String	toStringRedacted()	Redacts sensitive information from the string representation of this Module object, by calling Redactable.toStringRedacted() on #grade and all Exams in the EXAMS list.

Methods inherited from class java.lang.Object

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

Field Details

code

@Nullable
private String code

Uniquely identifies the module among all modules of the university, e.g. FMI-IN0144 for the module “Fortgeschrittenes Programmierpraktikum” (meaning “Advanced Programming Lab”) of the Faculty of Mathematics and Informatics.

title

@Nullable
private String title

The human-readable name of the module, e.g. Fortgeschrittenes Programmierpraktikum (meaning “Advanced Programming Lab”).

semester

@Nullable
private Semester semester

When the module took place.

grade

@Nullable
private Grade grade

The total grade of the module, an average of the EXAMS that are part of the module. May be missing if the person who entered the exams' grades into Friedolin forgot to enter the module's grade.

Missing grade:

status

@Nullable
private Exam.ExamStatus status

Whether the module is finished and, if so, whether successfully or not.

ects

@Nullable
private ECTS ects

The number of ECTS credits the module is worth.

EXAMS

@NonNull
private final @NonNull ArrayList<Exam> EXAMS

The exams that are part of the module and that have already been entered into the Friedolin system.

Constructor Details

Module

public Module()

Method Details

getExams

@NonNull
public @NonNull ArrayList<Exam> getExams()

Returns:

The exams that are part of the module and that have already been entered into the Friedolin system.

getCode

@NonNull
public @NonNull Optional<String> getCode()

Returns:

The code of the module, which uniquely identifies the module among all modules of the university.

getTitle

@NonNull
public @NonNull Optional<String> getTitle()

Returns:

The title of the module, the human-readable name of the module.

getSemester

@NonNull
public @NonNull Optional<Semester> getSemester()

Returns:

The semester in which the module took place.

getGrade

@NonNull
public @NonNull Optional<Grade> getGrade()

Returns:

The grade of the module, the total grade of the module, an average of the EXAMS that are part of the module.

getStatus

@NonNull
public @NonNull Optional<Exam.ExamStatus> getStatus()

Returns:

The status of the module, whether the module is finished and, if so, whether successfully or not.

getECTS

@NonNull
public @NonNull Optional<ECTS> getECTS()

Returns:

The ects of the module, the number of ECTS credits the module is worth.

setCode

public void setCode(@NonNull
 @NonNull String code)
             throws IllegalArgumentException

Updates the code of the module, which uniquely identifies the module among all modules of the university.

Parameters:

code - The new code of the module. Must not be blank.

Throws:

IllegalArgumentException - If the given code is blank.

setTitle

public void setTitle(@NonNull
 @NonNull String title)
              throws IllegalArgumentException

Updates the title of the module, the human-readable name of the module.

Parameters:

title - The new title of the module. Must not be blank.

Throws:

IllegalArgumentException - If the given title is blank.

setSemester

public void setSemester(@NonNull
 @NonNull Semester semester)

Updates the semester in which the module took place.

Parameters:

semester - The new semester of the module.

setGrade

public void setGrade(@NonNull
 @NonNull Grade grade)

Updates the grade of the module, the total grade of the module, an average of the EXAMS that are part of the module.

Parameters:

grade - The new grade of the module.

setStatus

public void setStatus(@NonNull
 Exam.ExamStatus status)

Updates the status of the module, whether the module is finished and, if so, whether successfully or not.

Parameters:

status - The new status of the module.

setECTS

public void setECTS(@NonNull
 @NonNull ECTS ects)

Updates the ects of the module, the number of ECTS credits the module is worth.

Parameters:

ects - The new ects of the module.

addExam

public void addExam(@NonNull
 @NonNull Exam exam)

Inserts a new Exam at the end of the EXAMS list.

Parameters:

exam - The new Exam to add to the module.

addExams

public void addExams(@NonNull
 @NonNull Exam... exams)

Inserts new Exams at the end of the EXAMS list, in the order they are specified.

Parameters:

exams - The new Exams to add to the module.

addExams

public void addExams(@NonNull
 @NonNull ArrayList<Exam> exams)

Inserts new Exams at the end of the EXAMS list, in the order they are specified.

Parameters:

exams - The new Exams to add to the module.

removeExam

public boolean removeExam(@NonNull
 @NonNull Exam exam)

Removes the first occurrence of the specified Exam from the EXAMS list, if it is present.

Parameters:

exam - The Exam to remove from the module.

Returns:

true if the list of exams contained the specified exam, false otherwise.

removeExams

public boolean removeExams(@NonNull
 @NonNull Exam... exams)

Removes the specified Exams from the EXAMS list, if they are present.

Parameters:

exams - The Exams to remove from the module.

Returns:

true if the list of exams was modified as a result of this operation.

Implementation Note:

See ArrayList.removeAll(Collection).

removeExam

@NonNull
public @NonNull Exam removeExam(int index)
                         throws IndexOutOfBoundsException

Removes the Exam at the specified position in the exams list.

Parameters:

index - The index of the Exam to remove from the module. Must be between 0 (inclusive) and the size of the exams list (exclusive).

Throws:

IndexOutOfBoundsException - If the index is out of bounds.

removeExams

@NonNull
public @NonNull ArrayList<Exam> removeExams(int... indices)
                                     throws IndexOutOfBoundsException

Removes the Exams at the specified positions in the exams list.

Parameters:

indices - The indices of the Exams to remove from the module. Must be between 0 (inclusive) and the size of the exams list (exclusive).

Returns:

The Exams that were removed from the module.

Throws:

IndexOutOfBoundsException - If any of the indices are out of bounds.

resetExams

public void resetExams()

Removes all Exams from the EXAMS list.

toString

@NonNull
public @NonNull String toString()

Specified by:

toString in interface Redactable

Overrides:

toString in class Object

Returns:

A string representation of this Module object.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Redacts sensitive information from the string representation of this Module object, by calling Redactable.toStringRedacted() on #grade and all Exams in the EXAMS list.

Specified by:

toStringRedacted in interface Redactable

Returns:

A redacted string representation of this Module object.