com.phloc.masterdata.address.ReadonlyAddress 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.address;

import java.util.Locale;

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

import com.phloc.commons.equals.EqualsUtils;
import com.phloc.commons.hash.HashCodeGenerator;
import com.phloc.commons.locale.country.CountryCache;
import com.phloc.commons.string.ToStringGenerator;

/**
 * Read-only implementation of the {@link IReadonlyAddress} interface.
 * 
 * @author Philip Helger
 */
@Immutable
public final class ReadonlyAddress implements IReadonlyAddress
{
  private final EAddressType m_eType;
  private final String m_sCountry;
  private final String m_sState;
  private final String m_sPostalCode;
  private final String m_sCity;
  private final String m_sStreet;
  private final String m_sBuildingNumber;
  private final String m_sPostOfficeBox;

  public ReadonlyAddress (@Nonnull final IReadonlyAddress aBase, @Nonnull final Locale aSortLocale)
  {
    this (aBase.getType (),
          aBase.getCountry (),
          aBase.getState (),
          aBase.getPostalCode (),
          aBase.getCity (),
          aBase.getStreet (),
          aBase.getBuildingNumber (),
          aBase.getPostOfficeBox (),
          aSortLocale);
  }

  public ReadonlyAddress (@Nullable final EAddressType eType,
                          @Nullable final String sCountry,
                          @Nullable final String sState,
                          @Nullable final String sPostalCode,
                          @Nullable final String sCity,
                          @Nullable final String sStreet,
                          @Nullable final String sBuildingNumber,
                          @Nullable final String sPostOfficeBox,
                          @Nonnull final Locale aSortLocale)
  {
    m_eType = eType;
    m_sCountry = AddressUtils.getUnifiedCountry (sCountry, aSortLocale);
    m_sState = AddressUtils.getUnifiedState (sState, aSortLocale);
    m_sPostalCode = sPostalCode;
    m_sCity = AddressUtils.getUnifiedCity (sCity, aSortLocale);
    m_sStreet = AddressUtils.getUnifiedStreet (sStreet, aSortLocale);
    m_sBuildingNumber = sBuildingNumber;
    m_sPostOfficeBox = AddressUtils.getUnifiedPOBox (sPostOfficeBox, aSortLocale);
  }

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

  @Nullable
  public String getCountry ()
  {
    return m_sCountry;
  }

  @Nullable
  public Locale getCountryLocale ()
  {
    return CountryCache.getCountry (m_sCountry);
  }

  @Nullable
  public String getCountryDisplayName (@Nonnull final Locale aDisplayLocale)
  {
    final Locale aCountry = getCountryLocale ();
    return aCountry == null ? null : aCountry.getDisplayCountry (aDisplayLocale);
  }

  @Nullable
  public String getState ()
  {
    return m_sState;
  }

  @Nullable
  public String getPostalCode ()
  {
    return m_sPostalCode;
  }

  @Nullable
  public String getCity ()
  {
    return m_sCity;
  }

  @Nullable
  public String getStreet ()
  {
    return m_sStreet;
  }

  @Nullable
  public String getBuildingNumber ()
  {
    return m_sBuildingNumber;
  }

  @Nullable
  public String getPostOfficeBox ()
  {
    return m_sPostOfficeBox;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (!(o instanceof ReadonlyAddress))
      return false;
    final ReadonlyAddress rhs = (ReadonlyAddress) o;
    return EqualsUtils.equals (m_eType, rhs.m_eType) &&
           EqualsUtils.equals (m_sCountry, rhs.m_sCountry) &&
           EqualsUtils.equals (m_sState, rhs.m_sState) &&
           EqualsUtils.equals (m_sPostalCode, rhs.m_sPostalCode) &&
           EqualsUtils.equals (m_sCity, rhs.m_sCity) &&
           EqualsUtils.equals (m_sStreet, rhs.m_sStreet) &&
           EqualsUtils.equals (m_sBuildingNumber, rhs.m_sBuildingNumber) &&
           EqualsUtils.equals (m_sPostOfficeBox, rhs.m_sPostOfficeBox);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_eType)
                                       .append (m_sCountry)
                                       .append (m_sState)
                                       .append (m_sPostalCode)
                                       .append (m_sCity)
                                       .append (m_sStreet)
                                       .append (m_sBuildingNumber)
                                       .append (m_sPostOfficeBox)
                                       .getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (null).appendIfNotNull ("type", m_eType)
                                       .appendIfNotNull ("country", m_sCountry)
                                       .appendIfNotNull ("state", m_sState)
                                       .appendIfNotNull ("postalCodeCode", m_sPostalCode)
                                       .appendIfNotNull ("city", m_sCity)
                                       .appendIfNotNull ("street", m_sStreet)
                                       .appendIfNotNull ("buildingNumber", m_sBuildingNumber)
                                       .appendIfNotNull ("pobox", m_sPostOfficeBox)
                                       .toString ();
  }
}