Package eu.rarogsoftware.rarog.platform.security.mfa.recovery

Record Class RecoveryCodesService.RecoveryCodeLoginResult

java.lang.Object

java.lang.Record

eu.rarogsoftware.rarog.platform.security.mfa.recovery.RecoveryCodesService.RecoveryCodeLoginResult

Enclosing interface:

RecoveryCodesService

public static record RecoveryCodesService.RecoveryCodeLoginResult(RecoveryCodesService.RecoveryCodeLoginResult.Status status, List<String> newCodes)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RecoveryCodesService.RecoveryCodeLoginResult.Status

Constructor Summary

Constructors

Constructor	Description
RecoveryCodeLoginResult(RecoveryCodesService.RecoveryCodeLoginResult.Status status, List<String> newCodes)	Creates an instance of a RecoveryCodeLoginResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static RecoveryCodesService.RecoveryCodeLoginResult	failure()
final int	hashCode()	Returns a hash code value for this object.
boolean	isSuccess()
List<String>	newCodes()	Returns the value of the newCodes record component.
(package private) static RecoveryCodesService.RecoveryCodeLoginResult	regenerated(List<String> newCodes)
RecoveryCodesService.RecoveryCodeLoginResult.Status	status()	Returns the value of the status record component.
static RecoveryCodesService.RecoveryCodeLoginResult	success()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

RecoveryCodeLoginResult

public RecoveryCodeLoginResult(RecoveryCodesService.RecoveryCodeLoginResult.Status status,
 List<String> newCodes)

Creates an instance of a RecoveryCodeLoginResult record class.

Parameters:

status - the value for the status record component

newCodes - the value for the newCodes record component

Method Details

success

public static RecoveryCodesService.RecoveryCodeLoginResult success()

failure

public static RecoveryCodesService.RecoveryCodeLoginResult failure()

regenerated

static RecoveryCodesService.RecoveryCodeLoginResult regenerated(List<String> newCodes)

isSuccess

public boolean isSuccess()

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

status

public RecoveryCodesService.RecoveryCodeLoginResult.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

newCodes

public List<String> newCodes()

Returns the value of the newCodes record component.

Returns:

the value of the newCodes record component