com.phloc.masterdata.email.ReadonlyExtendedEmailAddress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of phloc-masterdata Show documentation
Library with support for certain re-ocurring standard business objects
There is a newer version: 3.7.6
/**
 * Copyright (C) 2006-2014 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.phloc.masterdata.email;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import javax.persistence.Transient;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.phloc.commons.email.EmailAddressUtils;
import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.string.StringHelper;
import com.phloc.commons.string.ToStringGenerator;

/**
 * Default read-only implementation of {@link IReadonlyExtendedEmailAddress}.
 * 
 * @author Philip Helger
 */
@Immutable
public final class ReadonlyExtendedEmailAddress implements IReadonlyExtendedEmailAddress
{
  private static final Logger s_aLogger = LoggerFactory.getLogger (ReadonlyExtendedEmailAddress.class);

  private final EEmailAddressType m_eType;
  private final String m_sAddress;
  private final String m_sPersonal;

  public ReadonlyExtendedEmailAddress (@Nonnull final IReadonlyExtendedEmailAddress aBase)
  {
    this (aBase.getType (), aBase.getAddress (), aBase.getPersonal ());
  }

  public ReadonlyExtendedEmailAddress (@Nullable final EEmailAddressType eType, @Nullable final String sAddress)
  {
    this (eType, sAddress, null);
  }

  public ReadonlyExtendedEmailAddress (@Nullable final EEmailAddressType eType,
                                       @Nullable final String sAddress,
                                       @Nullable final String sPersonal)
  {
    m_eType = eType;
    String sRealAddress = EmailAddressUtils.getUnifiedEmailAddress (sAddress);
    if (sRealAddress != null && !EmailAddressUtils.isValid (sRealAddress))
    {
      s_aLogger.error ("Illegal email address passed: '" + sRealAddress + "'");
      sRealAddress = null;
    }
    m_sAddress = sRealAddress;
    m_sPersonal = sPersonal;
  }

  @Nullable
  public EEmailAddressType getType ()
  {
    return m_eType;
  }

  @Nullable
  public String getAddress ()
  {
    return m_sAddress;
  }

  @Nullable
  public String getPersonal ()
  {
    return m_sPersonal;
  }

  @Transient
  @Nonnull
  public String getDisplayName ()
  {
    if (StringHelper.hasText (m_sPersonal))
      return m_sPersonal + " <" + m_sAddress + ">";
    return m_sAddress;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!(o instanceof ReadonlyExtendedEmailAddress))
      return false;
    final ReadonlyExtendedEmailAddress rhs = (ReadonlyExtendedEmailAddress) o;
    return EqualsUtils.equals (m_eType, rhs.m_eType) &&
           EqualsUtils.equals (m_sAddress, rhs.m_sAddress) &&
           EqualsUtils.equals (m_sPersonal, rhs.m_sPersonal);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_eType).append (m_sAddress).append (m_sPersonal).getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (null).appendIfNotNull ("type", m_eType)
                                       .appendIfNotNull ("address", m_sAddress)
                                       .appendIfNotNull ("personal", m_sPersonal)
                                       .toString ();
  }

  @Nullable
  public static ReadonlyExtendedEmailAddress createOnDemand (@Nullable final String sAddress)
  {
    if (StringHelper.hasNoText (sAddress))
      return null;

    return new ReadonlyExtendedEmailAddress (null, sAddress, null);
  }
}