com.helger.masterdata.person.ESalutation Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2014-2018 Philip Helger (www.helger.com)
 * philip[at]helger[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.helger.masterdata.person;

import java.util.Locale;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.id.IHasID;
import com.helger.commons.lang.EnumHelper;
import com.helger.commons.text.display.IHasDisplayText;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

/**
 * Represents salutations for persons.
 *
 * @author Philip Helger
 */
@SuppressFBWarnings ("NP_NONNULL_PARAM_VIOLATION")
public enum ESalutation implements IHasDisplayText, IHasID 
{
  MISTER ("mr", EGender.MALE, ESalutationName.MISTER, ESalutationGreeting.MISTER, ESalutationGreetingComplete.MISTER),
  MISSES ("mrs",
          EGender.FEMALE,
          ESalutationName.MISSES,
          ESalutationGreeting.MISSES,
          ESalutationGreetingComplete.MISSES),
  FAMILY ("fam", null, ESalutationName.FAMILY, ESalutationGreeting.FAMILY, ESalutationGreetingComplete.FAMILY),
  COMPANY ("com", null, ESalutationName.COMPANY, ESalutationGreeting.COMPANY, ESalutationGreetingComplete.COMPANY),
  CLUB ("cl", null, ESalutationName.CLUB, ESalutationGreeting.CLUB, ESalutationGreetingComplete.CLUB);

  private final String m_sID;
  private final EGender m_eGender;
  private final IHasDisplayText m_aName;
  private final IHasDisplayText m_aGreeting;
  private final IHasDisplayText m_aGreetingComplete;

  private ESalutation (@Nonnull final String sID,
                       @Nullable final EGender eGender,
                       @Nonnull final ESalutationName eName,
                       @Nonnull final ESalutationGreeting eGreeting,
                       @Nonnull final ESalutationGreetingComplete eGreetingComplete)
  {
    m_sID = sID;
    m_eGender = eGender;
    m_aName = eName;
    m_aGreeting = eGreeting;
    m_aGreetingComplete = eGreetingComplete;
  }

  @Nonnull
  public String getID ()
  {
    return m_sID;
  }

  /**
   * @return The gender matching this salutation. May be null for
   *         non-individual salutations.
   */
  @Nullable
  public EGender getGender ()
  {
    return m_eGender;
  }

  public boolean hasGender ()
  {
    return m_eGender != null;
  }

  @Nonnull
  public IHasDisplayText getName ()
  {
    return m_aName;
  }

  @Nullable
  public String getDisplayText (@Nonnull final Locale aContentLocale)
  {
    return m_aName.getDisplayText (aContentLocale);
  }

  @Nonnull
  public IHasDisplayText getGreeting ()
  {
    return m_aGreeting;
  }

  @Nullable
  public String getGreeting (final Locale aContentLocale)
  {
    return m_aGreeting.getDisplayText (aContentLocale);
  }

  @Nullable
  public String getGreetingComplete (final Locale aContentLocale)
  {
    return m_aGreetingComplete.getDisplayText (aContentLocale);
  }

  @Nullable
  public static ESalutation getFromIDOrNull (@Nullable final String sSalutationID)
  {
    return EnumHelper.getFromIDOrNull (ESalutation.class, sSalutationID);
  }

  @Nullable
  public static ESalutation getFromIDOrDefault (@Nullable final String sSalutationID,
                                                @Nullable final ESalutation eDefault)
  {
    return EnumHelper.getFromIDOrDefault (ESalutation.class, sSalutationID, eDefault);
  }

  @Nullable
  public static ESalutation getFromDisplayNameOrNull (@Nullable final String sSalutation,
                                                      @Nonnull final Locale aContentLocale)
  {
    return getFromDisplayNameOrDefault (sSalutation, aContentLocale, null);
  }

  @Nullable
  public static ESalutation getFromDisplayNameOrDefault (@Nullable final String sSalutation,
                                                         @Nonnull final Locale aContentLocale,
                                                         @Nullable final ESalutation eDefault)
  {
    if (sSalutation != null)
      for (final ESalutation eSalutation : values ())
      {
        final String sDisplayName = eSalutation.getDisplayText (aContentLocale);
        if (sDisplayName.equals (sSalutation))
          return eSalutation;
      }
    return eDefault;
  }
}