Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Account

java.lang.Object

page.codeberg.friedolyn.grades.Account

public class Account
extends Object

A top-level group of Modules.

Field Summary

Fields

Modifier and Type	Field	Description
private String	code	The unique identifier of the account.
private ECTS	ects	The number of ECTS credits that the account's modules are worth in total.
private final @NonNull ArrayList<Module>	MODULES	The modules that are part of this account but not of any subaccounts.
private final @NonNull ArrayList<Subaccount>	SUB_ACCOUNTS	The subaccounts that are part of this account and may contain their own Modules.
private String	title	The human-readable name of the account, e.g.

Constructor Summary

Constructors

Constructor	Description
Account()

Method Summary

Modifier and Type	Method	Description
void	addModule(@NonNull Module module)	Adds a Module to the end of this account's modules list.
void	addModules(@NonNull Module... modules)	Adds the specified Modules to the end of this account's modules list.
void	addSubaccount(@NonNull Subaccount subaccount)	Inserts the specified Subaccount at the end of this account's subaccounts list.
void	addSubaccounts(@NonNull Subaccount... subaccounts)	Inserts the specified Subaccounts at the end of this account's subaccounts list, in the given order.
void	clearModules()	Removes all modules from this account's modules list.
void	clearSubaccounts()	Removes all subaccounts from this account's subaccounts list.
boolean	equals(Object object)	Checks if the values of this account's fields are equal to their counterparts in the given object (if it is an Account at all).
@NonNull Optional<String>	getCode()
@NonNull Optional<ECTS>	getECTS()
@NonNull ArrayList<Module>	getModules()
@NonNull ArrayList<Module>	getOrphanModules()
@NonNull ArrayList<Subaccount>	getSubaccounts()
@NonNull Optional<String>	getTitle()
@NonNull Module	removeModule(int index)	Removes the module at the specified position in this account's modules list.
boolean	removeModule(@NonNull Module module)	Removes the first occurrence of the specified Module from this account's modules list, if it is present.
@NonNull ArrayList<Module>	removeModules(int... indices)	Removes the modules at the specified positions in this account's modules list.
boolean	removeModules(@NonNull Module... modules)	Removes the specified Modules from this account's modules list, if they are present.
@NonNull Subaccount	removeSubaccount(int index)	Removes the subaccount at the specified position in this account's subaccounts list.
boolean	removeSubaccount(@NonNull Subaccount subaccount)	Removes the first occurrence of the specified Subaccount from this account's subaccounts list, if it is present.
@NonNull ArrayList<Subaccount>	removeSubaccounts(int... indices)	Removes the subaccounts at the specified positions in this account's subaccounts list.
boolean	removeSubaccounts(@NonNull Subaccount... subaccounts)	Removes the specified Subaccounts from this account's subaccounts list, if they are present.
void	setCode(@NonNull String code)	Updates the account's code to the given value.
void	setECTS(@NonNull ECTS ects)	Updates the account's ects to the given value.
void	setTitle(@NonNull String title)	Updates the account's title to the given value.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Field Details

code

@Nullable
private String code

The unique identifier of the account. Usually just a capital letter, e.g. A or B. Does not contain the prefix label Konto.

title

@Nullable
private String title

The human-readable name of the account, e.g. Module zur Vermittlung von mathematischen und naturwissenschaftlich-technischen Grundlagen (meaning “Modules for the Conveyance of Mathematical and Scientific-Technical Basics”).

ects

@Nullable
private ECTS ects

The number of ECTS credits that the account's modules are worth in total.

SUB_ACCOUNTS

@NonNull
private final @NonNull ArrayList<Subaccount> SUB_ACCOUNTS

The subaccounts that are part of this account and may contain their own Modules.

MODULES

@NonNull
private final @NonNull ArrayList<Module> MODULES

The modules that are part of this account but not of any subaccounts.

Constructor Details

Account

public Account()

Method Details

getCode

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

Returns:

The unique identifier of the account. Usually just a capital letter, e.g. A or B. Does not contain the prefix label Konto.

getTitle

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

Returns:

The human-readable name of the account, e.g. Module zur Vermittlung von mathematischen und naturwissenschaftlich-technischen Grundlagen (meaning “Modules for the Conveyance of Mathematical and Scientific-Technical Basics”).

getECTS

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

Returns:

The number of ECTS credits that the account's modules are worth in total.

getSubaccounts

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

Returns:

The subaccounts that are part of this account and may contain their own Modules.

getOrphanModules

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

Returns:

The modules that are part of this account but not of any subaccounts.

getModules

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

Returns:

All modules that are part of this account, including those of its subaccounts.

setCode

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

Updates the account's code to the given value.

Parameters:

code - The new account code, which uniquely identifies the account among all accounts of the university. Must not be blank.

Throws:

IllegalArgumentException - If the given code is blank.

setTitle

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

Updates the account's title to the given value.

Parameters:

title - The new account title, the human-readable name of the account. Must not be blank.

Throws:

IllegalArgumentException - If the given title is blank.

setECTS

public void setECTS(@NonNull
 @NonNull ECTS ects)

Updates the account's ects to the given value.

Parameters:

ects - The new number of ECTS credits that the account's modules are worth in total.

addSubaccount

public void addSubaccount(@NonNull
 @NonNull Subaccount subaccount)

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

addSubaccounts

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

Inserts the specified Subaccounts at the end of this account'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 account'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 account'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 account'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 account'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 account's subaccounts list.

addModule

public void addModule(@NonNull
 @NonNull Module module)

Adds a Module to the end of this account'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 account'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 account'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 account'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 account'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 account'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 account's modules list.

equals

public boolean equals(@Nullable
 Object object)

Checks if the values of this account's fields are equal to their counterparts in the given object (if it is an Account at all).

Overrides:

equals in class Object

Parameters:

object - The object to compare this account with.

Returns:

true if the given object is an account 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 account, including all its fields, as well as this account's hash code.