Record Class EmailAddress

java.lang.Object
java.lang.Record
net.tangly.core.EmailAddress
public record EmailAddress(@NotNull String recipient, @NotNull String domain) extends Record
The abstraction of an email address until the Java JDK provides one.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EmailAddress(@NotNull String recipient, @NotNull String domain)
    Creates an instance of a EmailAddress record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull String
    domain()
    Returns the value of the domain 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.
    static boolean
    isValid(String email)
     
    static EmailAddress
    of(String email)
     
    @NotNull String
    recipient()
    Returns the value of the recipient record component.
    String
    text()
    Returns a text representation of an email address.
    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

    • EmailAddress

      public EmailAddress(@NotNull @NotNull String recipient, @NotNull @NotNull String domain)
      Creates an instance of a EmailAddress record class.
      Parameters:
      recipient - the value for the recipient record component
      domain - the value for the domain record component

  • Method Details

    • of

      public static EmailAddress of(String email)

    • isValid

      public static boolean isValid(String email)

    • text

      public String text()
      Returns a text representation of an email address. The Object.toString() method is not used because the implementation is defined in the API implementation of record construct. The generated string can be feed to the of(String) to create an email address object.
      Returns:
      text representation

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

    • recipient

      @NotNull public @NotNull String recipient()
      Returns the value of the recipient record component.
      Returns:
      the value of the recipient record component

    • domain

      @NotNull public @NotNull String domain()
      Returns the value of the domain record component.
      Returns:
      the value of the domain record component