com.helger.masterdata.locale.ISO639_2Item 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.locale;

import java.io.Serializable;

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

import com.helger.commons.ValueEnforcer;
import com.helger.commons.annotation.Nonempty;
import com.helger.commons.equals.EqualsHelper;
import com.helger.commons.hashcode.HashCodeGenerator;
import com.helger.commons.string.StringHelper;
import com.helger.commons.string.ToStringGenerator;

public class ISO639_2Item implements Serializable
{
  private final String m_sAlpha3B;
  private final String m_sAlpha3T;
  private final String m_sAlpha2;
  private final String m_sEN;
  private final String m_sFR;

  public ISO639_2Item (@Nonnull @Nonempty final String sAlpha3B,
                       @Nullable final String sAlpha3T,
                       @Nullable final String sAlpha2,
                       @Nonnull @Nonempty final String sEN,
                       @Nonnull @Nonempty final String sFR)
  {
    ValueEnforcer.isTrue (StringHelper.getLength (sAlpha3B) == 3,
                          "Alpha3-bibliographic code must be present and have length 3: '" +
                                                                  sAlpha3B +
                                                                  "' - length " +
                                                                  StringHelper.getLength (sAlpha3B));
    if (sAlpha3T != null)
      ValueEnforcer.isTrue (sAlpha3T.length () == 3, "Alpha3-terminologic code must have length 3!");
    if (sAlpha2 != null)
      ValueEnforcer.isTrue (sAlpha2.length () == 2, "Alpha2 code must have length 2!");
    ValueEnforcer.notEmpty (sEN, "English name");
    ValueEnforcer.notEmpty (sFR, "French name");
    m_sAlpha3B = sAlpha3B;
    m_sAlpha3T = sAlpha3T;
    m_sAlpha2 = sAlpha2;
    m_sEN = sEN;
    m_sFR = sFR;
  }

  /**
   * @return The 3-letter bibliographic version. This is the default ISO-639-2
   *         3-letter code. Never null.
   */
  @Nonnull
  @Nonempty
  public String getAlpha3Bibliographic ()
  {
    return m_sAlpha3B;
  }

  /**
   * @return The 3-letter terminologic version. This code is optional and may be
   *         null. If it is not null the length is 3.
   */
  @Nullable
  public String getAlpha3Terminologic ()
  {
    return m_sAlpha3T;
  }

  /**
   * @return The 2-letter version. This code is optional and may be
   *         null. If it is not null the length is 2.
   */
  @Nullable
  public String getAlpha2 ()
  {
    return m_sAlpha2;
  }

  /**
   * @return The English Name of the language. Never null.
   */
  @Nonnull
  @Nonempty
  public String getEnglishName ()
  {
    return m_sEN;
  }

  /**
   * @return The French Name of the language. Never null.
   */
  @Nonnull
  @Nonempty
  public String getFrenchName ()
  {
    return m_sFR;
  }

  @Override
  public boolean equals (final Object o)
  {
    if (o == this)
      return true;
    if (o == null || !getClass ().equals (o.getClass ()))
      return false;
    final ISO639_2Item rhs = (ISO639_2Item) o;
    return m_sAlpha3B.equals (rhs.m_sAlpha3B) &&
           EqualsHelper.equals (m_sAlpha3T, rhs.m_sAlpha3T) &&
           EqualsHelper.equals (m_sAlpha2, rhs.m_sAlpha2) &&
           m_sEN.equals (rhs.m_sEN) &&
           m_sFR.equals (rhs.m_sFR);
  }

  @Override
  public int hashCode ()
  {
    return new HashCodeGenerator (this).append (m_sAlpha3B)
                                       .append (m_sAlpha3T)
                                       .append (m_sAlpha2)
                                       .append (m_sEN)
                                       .append (m_sFR)
                                       .getHashCode ();
  }

  @Override
  public String toString ()
  {
    return new ToStringGenerator (this).append ("alpha3b", m_sAlpha3B)
                                       .append ("alpha3t", m_sAlpha3T)
                                       .append ("alpha2", m_sAlpha2)
                                       .append ("English", m_sEN)
                                       .append ("French", m_sFR)
                                       .getToString ();
  }
}