us.fatehi.creditcardnumber.Name Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of credit_card_number Show documentation
Credit Card Number is a library that can provide details of a bank issued credit card number. All classes are immutable and thread-safe. The standard `toString()` function formats data in a readable form.
There is a newer version: 3.0.0
Show newest version
/*
 *
 * Credit Card Number
 * https://github.com/sualeh/credit_card_number
 * Copyright (c) 2014-2015, Sualeh Fatehi.
 *
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 */
package us.fatehi.creditcardnumber;


import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.trimToEmpty;
import static org.apache.commons.lang3.text.WordUtils.capitalizeFully;

import java.io.Serializable;

/**
 * Parses and represents the cardholder's name.
 */
public final class Name
  extends BaseRawData
  implements Serializable
{

  private static final long serialVersionUID = 6735627336462134892L;

  private final String firstName;
  private final String lastName;

  /**
   * No name.
   */
  public Name()
  {
    this(null);
  }

  /**
   * Name from raw magnetic track data.
   *
   * @param rawName
   *        Raw magnetic track data for name.
   */
  public Name(final String rawName)
  {
    super(rawName);

    final String[] splitName = trimToEmpty(rawName).split("/");
    firstName = name(splitName, 1);
    lastName = name(splitName, 0);
  }

  /**
   * Name from first and last.
   *
   * @param firstName
   *        First name.
   * @param lastName
   *        Last name.
   */
  public Name(final String firstName, final String lastName)
  {
    super(null);
    this.firstName = firstName;
    this.lastName = lastName;
  }

  /**
   * @see java.lang.Object#equals(java.lang.Object)
   */
  @Override
  public boolean equals(final Object obj)
  {
    if (this == obj)
    {
      return true;
    }
    if (obj == null)
    {
      return false;
    }
    if (!(obj instanceof Name))
    {
      return false;
    }
    final Name other = (Name) obj;
    if (firstName == null)
    {
      if (other.firstName != null)
      {
        return false;
      }
    }
    else if (!firstName.equalsIgnoreCase(other.firstName))
    {
      return false;
    }
    if (lastName == null)
    {
      if (other.lastName != null)
      {
        return false;
      }
    }
    else if (!lastName.equalsIgnoreCase(other.lastName))
    {
      return false;
    }
    return true;
  }

  /**
   * @see us.fatehi.creditcardnumber.RawData#exceedsMaximumLength()
   */
  @Override
  public boolean exceedsMaximumLength()
  {
    return trimToEmpty(getRawData()).length() > 26;
  }

  /**
   * Gets the first name.
   *
   * @return First name.
   */
  public String getFirstName()
  {
    return firstName;
  }

  /**
   * Gets the full name.
   *
   * @return full name.
   */
  public String getFullName()
  {
    final StringBuilder buffer = new StringBuilder();
    if (hasFirstName())
    {
      buffer.append(trimToEmpty(firstName));
    }
    if (hasFullName())
    {
      buffer.append(" ");
    }
    if (hasLastName())
    {
      buffer.append(trimToEmpty(lastName));
    }
    return buffer.toString();
  }

  /**
   * Gets the last name.
   *
   * @return Last name.
   */
  public String getLastName()
  {
    return lastName;
  }

  /**
   * Checks whether the first name is available.
   *
   * @return True if the first name is available.
   */
  public boolean hasFirstName()
  {
    return !isBlank(firstName);
  }

  /**
   * Checks whether the full name (first and last) is available.
   *
   * @return True if the full name is available.
   */
  public boolean hasFullName()
  {
    return hasFirstName() && hasLastName();
  }

  /**
   * @see java.lang.Object#hashCode()
   */
  @Override
  public int hashCode()
  {
    final int prime = 31;
    int result = 1;
    result = prime * result + (firstName == null? 0: firstName.hashCode());
    result = prime * result + (lastName == null? 0: lastName.hashCode());
    return result;
  }

  /**
   * Checks whether the last name is available.
   *
   * @return True if the last name is available.
   */
  public boolean hasLastName()
  {
    return !isBlank(lastName);
  }

  /**
   * Checks whether the name (either first or last) is available.
   *
   * @return True if the name is available.
   */
  public boolean hasName()
  {
    return hasFirstName() || hasLastName();
  }

  /**
   * @see java.lang.Object#toString()
   */
  @Override
  public String toString()
  {
    return getFullName();
  }

  private String name(final String[] splitName, final int position)
  {
    String name;
    if (splitName.length > position)
    {
      name = capitalizeFully(trimToEmpty(splitName[position]), new char[] {
          '.', '\'', ' '
      });
    }
    else
    {
      name = "";
    }

    return name;
  }

}