Package com.helger.base.email

Class EmailAddress

java.lang.Object
com.helger.base.email.EmailAddress
All Implemented Interfaces:
IEmailAddress, IHasDisplayName
@Immutable public class EmailAddress extends Object implements IEmailAddress
This class handles a single email address. It is split into an address part and an optional name. The personal name is optional and may be null.
Author:
Philip Helger

  • Constructor Details

    • EmailAddress

      public EmailAddress(@NonNull IEmailAddress aAddress)
      Copy constructor.
      Parameters:
      aAddress - The email address to copy from. May not be null.

    • EmailAddress

      public EmailAddress(@NonNull String sAddress)
      Constructor with address only.
      Parameters:
      sAddress - The email address string. May not be null.

    • EmailAddress

      public EmailAddress(@NonNull String sAddress, @Nullable String sPersonal)
      Constructor with address and optional personal name.
      Parameters:
      sAddress - The email address string. May not be null.
      sPersonal - The optional personal name. May be null.

  • Method Details

    • getAddress

      public @NonNull String getAddress()
      Specified by:
      getAddress in interface IEmailAddress
      Returns:
      The main email address. May not be null.

    • getPersonal

      public @Nullable String getPersonal()
      Specified by:
      getPersonal in interface IEmailAddress
      Returns:
      The personal name. May be null.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • createOnDemand

      public static @Nullable EmailAddress createOnDemand(@Nullable String sAddress)
      Factory method that creates an EmailAddress only if the provided address is non-empty.
      Parameters:
      sAddress - The email address string. May be null.
      Returns:
      null if the address is null or empty.

    • createOnDemand

      public static @Nullable EmailAddress createOnDemand(@Nullable String sAddress, @Nullable String sPersonal)
      Factory method that creates an EmailAddress only if the provided address is non-empty.
      Parameters:
      sAddress - The email address string. May be null.
      sPersonal - The optional personal name. May be null.
      Returns:
      null if the address is null or empty.