Package com.nicholasalfonso.lato.service

Record Class DashboardService.DashboardStatistics

java.lang.Object

java.lang.Record

com.nicholasalfonso.lato.service.DashboardService.DashboardStatistics

Record Components:

completionPercentage - overall assignment completion percentage

weeksLeftInSemester - estimated weeks remaining in the semester, if known

currentWeek - current week index within the semester range, if known

totalWeeks - total weeks in the semester range, if known

Enclosing class:

DashboardService

public static record DashboardService.DashboardStatistics(double completionPercentage, Long weeksLeftInSemester, Long currentWeek, Long totalWeeks)
extends Record

Dashboard statistics exposed to API clients.

Constructor Summary

Constructors

Constructor	Description
DashboardStatistics(double completionPercentage, Long weeksLeftInSemester, Long currentWeek, Long totalWeeks)	Creates an instance of a DashboardStatistics record class.

Method Summary

Modifier and Type	Method	Description
double	completionPercentage()	Returns the value of the completionPercentage record component.
Long	currentWeek()	Returns the value of the currentWeek record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
Long	totalWeeks()	Returns the value of the totalWeeks record component.
Long	weeksLeftInSemester()	Returns the value of the weeksLeftInSemester record component.

Methods inherited from class java.lang.Object

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

Constructor Details

DashboardStatistics

public DashboardStatistics(double completionPercentage,
 Long weeksLeftInSemester,
 Long currentWeek,
 Long totalWeeks)

Creates an instance of a DashboardStatistics record class.

Parameters:

completionPercentage - the value for the completionPercentage record component

weeksLeftInSemester - the value for the weeksLeftInSemester record component

currentWeek - the value for the currentWeek record component

totalWeeks - the value for the totalWeeks record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

completionPercentage

public double completionPercentage()

Returns the value of the completionPercentage record component.

Returns:

the value of the completionPercentage record component

weeksLeftInSemester

public Long weeksLeftInSemester()

Returns the value of the weeksLeftInSemester record component.

Returns:

the value of the weeksLeftInSemester record component

currentWeek

public Long currentWeek()

Returns the value of the currentWeek record component.

Returns:

the value of the currentWeek record component

totalWeeks

public Long totalWeeks()

Returns the value of the totalWeeks record component.

Returns:

the value of the totalWeeks record component