Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.grades

Class Degree

java.lang.Object

page.codeberg.friedolyn.grades.Degree

public class Degree
extends Object

Represents a university degree, e.g. Bachelor of Science. The degree may be assigned a unique number that identifies it in the Friedolin system.

Field Summary

Fields

Modifier and Type	Field	Description
private Integer	code	The number that identifies the degree uniquely.
static HashMap<Integer,KnownDegree>	NUMBERED_DEGREES	A collection of known degrees that are assigned a unique number.
private @NonNull String	title	The human-readable name of the degree, e.g.

Constructor Summary

Constructors

Constructor	Description
Degree(@NonNull String title)	Constructs a new Degree object with the given title.
Degree(@NonNull KnownDegree knownDegree)	Constructs a new Degree object with the given known degree.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
static @NonNull Optional<Integer>	extractCode(@NonNull String title)	Parses the degree code from the given title.
@NonNull Optional<Integer>	getCode()
void	setCode(@NonNull Integer code)	Updates the degree number that identifies the degree uniquely.
void	setTitle(@NonNull String title)	Updates the title of this degree.
@NonNull String	toString()

Methods inherited from class java.lang.Object

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

Field Details

NUMBERED_DEGREES

public static HashMap<Integer,KnownDegree> NUMBERED_DEGREES

A collection of known degrees that are assigned a unique number. The number is used to identify the degree in the Friedolin system.

code

@Nullable
private Integer code

The number that identifies the degree uniquely.

title

@NonNull
private @NonNull String title

The human-readable name of the degree, e.g. Bachelor of Science. If the degree is assigned a number, then it is removed from the title. The prefix Abschluss is also removed.

Constructor Details

Degree

public Degree(@NonNull
 @NonNull String title)
       throws IllegalArgumentException

Constructs a new Degree object with the given title. If the title contains a degree number, then it is extracted (removed) and stored in the code field. The prefix Abschluss is also removed, if present.

Parameters:

title - The human-readable name of the degree. Must not be blank.

Throws:

IllegalArgumentException - If the title is blank.

Degree

public Degree(@NonNull
 @NonNull KnownDegree knownDegree)

Constructs a new Degree object with the given known degree. The title is set to the known degree's label. If the known degree is assigned a degree number, then it is stored in the code field.

Parameters:

knownDegree - The known degree to set the title to.

Method Details

getCode

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

Returns:

The degree number that identifies the degree uniquely.

setTitle

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

Updates the title of this degree. If the title contains a degree number, then it is extracted (removed) and stored in the code field. The prefix Abschluss is also removed, if present.

Parameters:

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

Throws:

IllegalArgumentException - If the title is blank.

setCode

public void setCode(@NonNull
 @NonNull Integer code)

Updates the degree number that identifies the degree uniquely.

Parameters:

code - The new degree number.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

toString

@NonNull
public @NonNull String toString()

Overrides:

toString in class Object

extractCode

@NonNull
public static @NonNull Optional<Integer> extractCode(@NonNull
 @NonNull String title)

Parses the degree code from the given title.

Parameters:

title - The title containing the degree code.

Returns:

The degree code, if the title contains one. Empty otherwise.