Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Course

java.lang.Object

page.codeberg.friedolyn.grades.Course

public class Course
extends Object

Represents a course of study (Studiengang) at the university. Leads to a specific degree.

See Also:

• DegreeAndCourseHeading
• List of courses at the FSU

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull ArrayList<Account>	ACCOUNTS	The accounts that are part of this course and may contain their own Modules.
private String	courseName	The human-readable title of the course, e.g.
private Degree	degree	The university degree that this course will lead to.
private final @NonNull ArrayList<Module>	MODULES	The modules that are part of this course but not of any accounts.
private final @NonNull ArrayList<Subaccount>	SUBACCOUNTS	The subaccounts that are part of this course (but not of any accounts and may contain their own Modules.

Constructor Summary

Constructors

Constructor	Description
Course()

Method Summary

Modifier and Type	Method	Description
void	addAccount(@NonNull Account account)	Inserts a new Account at the end of this course's accounts list.
void	addAccounts(@NonNull Account... accounts)	Inserts the specified Accounts at the end of this course's accounts list.
void	addModule(@NonNull Module module)	Adds a Module to the end of this course's modules list.
void	addModules(@NonNull Module... modules)	Adds the specified Modules to the end of this course's modules list.
void	addSubaccount(@NonNull Subaccount subaccount)	Inserts the specified Subaccount at the end of this course's subaccounts list.
void	addSubaccounts(@NonNull Subaccount... subaccounts)	Inserts the specified Subaccounts at the end of this course's subaccounts list, in the given order.
void	clearAccounts()	Removes all accounts from this course's accounts list.
void	clearModules()	Removes all modules from this course's modules list.
void	clearSubaccounts()	Removes all subaccounts from this course's subaccounts list.
boolean	equals(Object object)	Checks whether the values of this course's fields are equal to their counterparts in the specified object (if it is a Course at all).
@NonNull ArrayList<Account>	getAccounts()
@NonNull Optional<String>	getCourseName()
@NonNull Optional<Degree>	getDegree()
@NonNull ArrayList<Module>	getModules()
@NonNull ArrayList<Module>	getOrphanModules()
@NonNull ArrayList<Subaccount>	getSubaccounts()
@NonNull Account	removeAccount(int index)	Removes the account at the specified position in this course's accounts list.
boolean	removeAccount(@NonNull Account account)	Removes the first occurrence of the specified Account from this course's accounts list, if it is present.
@NonNull ArrayList<Account>	removeAccounts(int... indices)	Removes the accounts at the specified positions in this course's accounts list.
boolean	removeAccounts(@NonNull Account... accounts)	Removes the specified Accounts from this course's accounts list, if they are present.
@NonNull Module	removeModule(int index)	Removes the module at the specified position in this course's modules list.
boolean	removeModule(@NonNull Module module)	Removes the first occurrence of the specified Module from this course's modules list, if it is present.
@NonNull ArrayList<Module>	removeModules(int... indices)	Removes the modules at the specified positions in this course's modules list.
boolean	removeModules(@NonNull Module... modules)	Removes the specified Modules from this course's modules list, if they are present.
@NonNull Subaccount	removeSubaccount(int index)	Removes the subaccount at the specified position in this course's subaccounts list.
boolean	removeSubaccount(@NonNull Subaccount subaccount)	Removes the first occurrence of the specified Subaccount from this course's subaccounts list, if it is present.
@NonNull ArrayList<Subaccount>	removeSubaccounts(int... indices)	Removes the subaccounts at the specified positions in this course's subaccounts list.
boolean	removeSubaccounts(@NonNull Subaccount... subaccounts)	Removes the specified Subaccounts from this course's subaccounts list, if they are present.
void	setCourseName(@NonNull String courseName)	Updates the human-readable title of the course.
void	setDegree(@NonNull Degree degree)	Updates the degree that this course will lead to.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Field Details

degree

@Nullable
private Degree degree

The university degree that this course will lead to.

courseName

@Nullable
private String courseName

The human-readable title of the course, e.g. Angewandte Informatik.

ACCOUNTS

@NonNull
private final @NonNull ArrayList<Account> ACCOUNTS

The accounts that are part of this course and may contain their own Modules.

SUBACCOUNTS

@NonNull
private final @NonNull ArrayList<Subaccount> SUBACCOUNTS

The subaccounts that are part of this course (but not of any accounts and may contain their own Modules.

MODULES

@NonNull
private final @NonNull ArrayList<Module> MODULES

The modules that are part of this course but not of any accounts.

Constructor Details

Course

public Course()

Method Details

getDegree

@NonNull
public @NonNull Optional<Degree> getDegree()

Returns:

The degree that this course will lead to.

getCourseName

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

Returns:

The human-readable title of the course, e.g. Angewandte Informatik.

getAccounts

@NonNull
public @NonNull ArrayList<Account> getAccounts()

Returns:

The accounts that are part of this course.

getSubaccounts

@NonNull
public @NonNull ArrayList<Subaccount> getSubaccounts()

Returns:

The subaccounts that are part of this course.

getOrphanModules

@NonNull
public @NonNull ArrayList<Module> getOrphanModules()

Returns:

The modules that are part of this course but not of any accounts.

getModules

@NonNull
public @NonNull ArrayList<Module> getModules()

Returns:

The modules that are part of this course, including those of the accounts that are associated with this course.

setDegree

public void setDegree(@NonNull
 @NonNull Degree degree)

Updates the degree that this course will lead to.

Parameters:

degree - The new degree.

setCourseName

public void setCourseName(@NonNull
 @NonNull String courseName)

Updates the human-readable title of the course.

Parameters:

courseName - The new course name.

addAccount

public void addAccount(@NonNull
 @NonNull Account account)

Inserts a new Account at the end of this course's accounts list.

Parameters:

account - The account to add.

addAccounts

public void addAccounts(@NonNull
 @NonNull Account... accounts)

Inserts the specified Accounts at the end of this course's accounts list.

Parameters:

accounts - The accounts to add.

removeAccount

public boolean removeAccount(@NonNull
 @NonNull Account account)

Removes the first occurrence of the specified Account from this course's accounts list, if it is present.

Parameters:

account - The account to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeAccounts

public boolean removeAccounts(@NonNull
 @NonNull Account... accounts)

Removes the specified Accounts from this course's accounts list, if they are present.

Parameters:

accounts - The accounts to remove.

Returns:

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

removeAccount

@NonNull
public @NonNull Account removeAccount(int index)
                               throws IndexOutOfBoundsException

Removes the account at the specified position in this course's accounts list.

Parameters:

index - The index of the account to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The account previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeAccounts

@NonNull
public @NonNull ArrayList<Account> removeAccounts(int... indices)
                                           throws IndexOutOfBoundsException

Removes the accounts at the specified positions in this course's accounts list.

Parameters:

indices - The indices of the accounts to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The accounts previously at the specified positions.

Throws:

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

clearAccounts

public void clearAccounts()

Removes all accounts from this course's accounts list.

addSubaccount

public void addSubaccount(@NonNull
 @NonNull Subaccount subaccount)

Inserts the specified Subaccount at the end of this course's subaccounts list.

addSubaccounts

public void addSubaccounts(@NonNull
 @NonNull Subaccount... subaccounts)

Inserts the specified Subaccounts at the end of this course's subaccounts list, in the given order.

removeSubaccount

public boolean removeSubaccount(@NonNull
 @NonNull Subaccount subaccount)

Removes the first occurrence of the specified Subaccount from this course's subaccounts list, if it is present.

Parameters:

subaccount - The subaccount to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeSubaccounts

public boolean removeSubaccounts(@NonNull
 @NonNull Subaccount... subaccounts)

Removes the specified Subaccounts from this course's subaccounts list, if they are present.

Parameters:

subaccounts - The subaccounts to remove.

Returns:

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

removeSubaccount

@NonNull
public @NonNull Subaccount removeSubaccount(int index)
                                     throws IndexOutOfBoundsException

Removes the subaccount at the specified position in this course's subaccounts list.

Parameters:

index - The index of the subaccount to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The subaccount previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeSubaccounts

@NonNull
public @NonNull ArrayList<Subaccount> removeSubaccounts(int... indices)
                                                 throws IndexOutOfBoundsException

Removes the subaccounts at the specified positions in this course's subaccounts list.

Parameters:

indices - The indices of the subaccounts to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The subaccounts previously at the specified positions.

Throws:

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

clearSubaccounts

public void clearSubaccounts()

Removes all subaccounts from this course's subaccounts list.

addModule

public void addModule(@NonNull
 @NonNull Module module)

Adds a Module to the end of this course's modules list.

Parameters:

module - The module to add.

addModules

public void addModules(@NonNull
 @NonNull Module... modules)

Adds the specified Modules to the end of this course's modules list.

Parameters:

modules - The modules to add.

removeModule

public boolean removeModule(@NonNull
 @NonNull Module module)

Removes the first occurrence of the specified Module from this course's modules list, if it is present.

Parameters:

module - The module to remove.

Returns:

true if this list contained the specified element, false otherwise.

removeModules

public boolean removeModules(@NonNull
 @NonNull Module... modules)

Removes the specified Modules from this course's modules list, if they are present.

Parameters:

modules - The modules to remove.

Returns:

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

removeModule

@NonNull
public @NonNull Module removeModule(int index)
                             throws IndexOutOfBoundsException

Removes the module at the specified position in this course's modules list.

Parameters:

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

Returns:

The module previously at the specified position.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeModules

@NonNull
public @NonNull ArrayList<Module> removeModules(int... indices)
                                         throws IndexOutOfBoundsException

Removes the modules at the specified positions in this course's modules list.

Parameters:

indices - The indices of the modules to remove. Must be between 0 (inclusive) and the size of the list (exclusive).

Returns:

The modules previously at the specified positions.

Throws:

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

clearModules

public void clearModules()

Removes all modules from this course's modules list.

equals

public boolean equals(Object object)

Checks whether the values of this course's fields are equal to their counterparts in the specified object (if it is a Course at all).

Overrides:

equals in class Object

Parameters:

object - The object to compare this course to.

Returns:

true if the object is a Course and all fields are deeply equal, false otherwise.

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

Returns:

A string representation of this course, including all its fields as well as this course's hash code.