Module page.codeberg.friedolyn.Friedolyn

Package page.codeberg.friedolyn.configuration

Class Notifications

java.lang.Object

page.codeberg.friedolyn.configuration.Notifications

All Implemented Interfaces:

Copyable<Notifications>, Redactable

public class Notifications
extends Object
implements Redactable, Copyable<Notifications>

The configuration for the notifications that Friedolyn shall send to the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Notifications.IncludeGrades	The possible values for the includeGrades field.

Field Summary

Fields

Modifier and Type	Field	Description
private EMailNotifier	emailNotifier	The notifier that will be used to send the e-mail notifications to the user via the university's SMTP server.
private double	goodGradesThreshold	This grade and all grades better that it will be included in the notification.
private Notifications.IncludeGrades	includeGrades	Whether to reveal the new grades in the notifications sent to the user.
private NtfyNotifier	ntfyNotifier	The notifier that will be used to send the push notifications to the user's device via the Ntfy service.
private UnifiedPushNotifier	unifiedPushNotifier	The notifier that will be used to send the push notifications to the user's device via the UnifiedPush service.

Constructor Summary

Constructors

Constructor	Description
Notifications()

Method Summary

Modifier and Type	Method	Description
@NonNull Notifications	copy()
@NonNull Optional<EMailNotifier>	getEmailNotifier()
@NonNull Optional<NtfyNotifier>	getNtfyNotifier()
@NonNull Optional<UnifiedPushNotifier>	getUnifiedPushNotifier()
boolean	isEmpty()
boolean	isPresent()
void	resetEmailNotifier()	Deletes the current EMail notifier, so that no notifications will be sent via e-mail.
void	resetNtfyNotifier()	Deletes the current Ntfy notifier, so that no notifications will be sent via Ntfy.
void	resetUnifiedPushNotifier()	Deletes the current UnifiedPush notifier, so that no notifications will be sent via UnifiedPush.
void	setEmailNotifier(@NonNull EMailNotifier emailNotifier)	Updates the includeGrades field to the exact reference of the given object.
void	setGoodGradesThreshold(double goodGradesThreshold)	Updates the includeGrades field to the given value.
void	setNtfyNotifier(@NonNull NtfyNotifier ntfyNotifier)	Updates the includeGrades field to the exact reference of the given object.
void	setUnifiedPushNotifier(@NonNull UnifiedPushNotifier unifiedPushNotifier)	Updates the includeGrades field to the exact reference of the given object.
@NonNull String	toString()
@NonNull String	toStringRedacted()

Methods inherited from class java.lang.Object

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

Field Details

includeGrades

private Notifications.IncludeGrades includeGrades

Whether to reveal the new grades in the notifications sent to the user.

goodGradesThreshold

private double goodGradesThreshold

This grade and all grades better that it will be included in the notification. Worse grades will not be revealed.

emailNotifier

@Nullable
private EMailNotifier emailNotifier

The notifier that will be used to send the e-mail notifications to the user via the university's SMTP server. If the user does not wish to receive notifications via e-mail, this field will be null.

ntfyNotifier

@Nullable
private NtfyNotifier ntfyNotifier

The notifier that will be used to send the push notifications to the user's device via the Ntfy service. If the user does not wish to receive notifications via Ntfy, this field will be null.

unifiedPushNotifier

@Nullable
private UnifiedPushNotifier unifiedPushNotifier

The notifier that will be used to send the push notifications to the user's device via the UnifiedPush service. If the user does not wish to receive notifications via UnifiedPush, this field will be null.

Constructor Details

Notifications

public Notifications()

Method Details

setGoodGradesThreshold

public void setGoodGradesThreshold(double goodGradesThreshold)
                            throws IllegalArgumentException

Updates the includeGrades field to the given value.

Parameters:

goodGradesThreshold - Grades equal to or better than (i.e. lower than) this value will be revealed in the notifications. Grades worse (i.e. higher) than this value will not be revealed. Must be between 1.0 and 4.0 (inclusive).

Throws:

IllegalArgumentException - If the given value is lower than 1.0 or greater than 4.0.

setEmailNotifier

public void setEmailNotifier(@NonNull
 @NonNull EMailNotifier emailNotifier)

Updates the includeGrades field to the exact reference of the given object.

Parameters:

emailNotifier - The new value for the emailNotifier field.

setNtfyNotifier

public void setNtfyNotifier(@NonNull
 @NonNull NtfyNotifier ntfyNotifier)

Updates the includeGrades field to the exact reference of the given object.

Parameters:

ntfyNotifier - The new value for the ntfyNotifier field.

setUnifiedPushNotifier

public void setUnifiedPushNotifier(@NonNull
 @NonNull UnifiedPushNotifier unifiedPushNotifier)

Updates the includeGrades field to the exact reference of the given object.

Parameters:

unifiedPushNotifier - The new value for the unifiedPushNotifier field.

resetEmailNotifier

public void resetEmailNotifier()

Deletes the current EMail notifier, so that no notifications will be sent via e-mail.

resetNtfyNotifier

public void resetNtfyNotifier()

Deletes the current Ntfy notifier, so that no notifications will be sent via Ntfy.

resetUnifiedPushNotifier

public void resetUnifiedPushNotifier()

Deletes the current UnifiedPush notifier, so that no notifications will be sent via UnifiedPush.

getEmailNotifier

@NonNull
public @NonNull Optional<EMailNotifier> getEmailNotifier()

Returns:

The exact reference of the emailNotifier. Empty if it is null.

getNtfyNotifier

@NonNull
public @NonNull Optional<NtfyNotifier> getNtfyNotifier()

Returns:

The exact reference of the ntfyNotifier. Empty if it is null.

getUnifiedPushNotifier

@NonNull
public @NonNull Optional<UnifiedPushNotifier> getUnifiedPushNotifier()

Returns:

The exact reference of the unifiedPushNotifier. Empty if it is null.

isEmpty

public boolean isEmpty()

Returns:

True if emailNotifier, ntfyNotifier, and unifiedPushNotifier are all null. False otherwise.

isPresent

public boolean isPresent()

copy

@NonNull
public @NonNull Notifications copy()

Specified by:

copy in interface Copyable<Notifications>

Returns:

A deep copy of the object, i.e. a clone that has the exact same values as the original object, but is a different instance (new reference).

toString

@NonNull
public @NonNull String toString()

Specified by:

toString in interface Redactable

Overrides:

toString in class Object

Returns:

A string representation of this object including all fields, even sensitive ones.

toStringRedacted

@NonNull
public @NonNull String toStringRedacted()

Specified by:

toStringRedacted in interface Redactable

Returns:

Same as toString(), but redacts the ntfyNotifier and unifiedPushNotifier if the debug level is set to DebugLevel.WARN or DebugLevel.ERROR.