Record Class EmailVerificationState

java.lang.Object
java.lang.Record
com.iizix.user.EmailVerificationState
Record Components:
email - The registered address, null when the user has none or the session has no user.
status - The status, never null.
public record EmailVerificationState(String email, EmailVerificationState.Status status) extends Record
The state of the registered e-mail address of a user, as IUserAuthenticationUI.getEmailVerificationState(IClientSessionGyro) answers it (CC-LOGIN-L10A1-SERVER-GAPS, gap G-3 of the SignIn flow design): the address, and whether the user has verified it by opening the mailed link. The detail IZS-EmailVerify of the user holds the code: 3 is verified, everything else is pending (0 not checked, 1 mail sent, 2 wrong address, 4 check later), and a user without an address has nothing to verify.
Author:
Christopher Mindus

  • Field Details

  • Constructor Details

    • EmailVerificationState

      public EmailVerificationState(String email, EmailVerificationState.Status status)
      Creates an instance of a EmailVerificationState record class.
      Parameters:
      email - the value for the email record component
      status - the value for the status record component

  • Method Details

    • isVerified

      public boolean isVerified()
      Checks if the address is verified.
      Returns:
      true when the status is EmailVerificationState.Status.VERIFIED.

    • isPending

      public boolean isPending()
      Checks if there is an address to verify.
      Returns:
      true when the status is EmailVerificationState.Status.PENDING.

    • 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.

    • email

      public String email()
      Returns the value of the email record component.
      Returns:
      the value of the email record component

    • status

      public EmailVerificationState.Status status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component