Name.java

package org.mafagafogigante.dungeon.game;

import org.mafagafogigante.dungeon.logging.DungeonLogger;

import org.jetbrains.annotations.NotNull;

import java.io.Serializable;
import java.util.Locale;

/**
 * Name immutable class that stores the singular and plural forms of a name.
 */
public final class Name implements Serializable {

  private static final long serialVersionUID = 3198273263451197501L;
  private final String singular;
  private final String plural;

  /**
   * Constructs a name based on the specified forms. Names should be created through NameFactory and not through this
   * constructor.
   *
   * @param singular the singular form, not null
   * @param plural the plural form, not null
   */
  Name(@NotNull String singular, @NotNull String plural) {
    this.singular = singular;
    this.plural = plural;
  }

  /**
   * Returns the singular form of this Name.
   */
  public String getSingular() {
    return singular;
  }

  /**
   * Returns the plural form of this Name.
   */
  public String getPlural() {
    return plural;
  }

  /**
   * Returns a string representing a quantified name using words for quantifiers. e.g.: {@code "One Sword", "Two Bears",
   * "Three Elephants", "A few Cows"}
   *
   * @param quantity the quantity, must be positive
   * @return a String
   */
  public String getQuantifiedName(int quantity) {
    return getQuantifiedName(quantity, QuantificationMode.WORD);
  }

  /**
   * Returns a string representing a quantified name using the specified quantification mode.
   *
   * @param quantity the quantity, must be positive
   * @param mode a QuantificationMode constant
   * @return a String
   */
  public String getQuantifiedName(int quantity, QuantificationMode mode) {
    String name;
    if (quantity < 0) {
      DungeonLogger.warning("Called getQuantifiedName with nonpositive quantity.");
      throw new AssertionError("Negative quantity passed to getQuantifiedName()!");
    } else if (quantity == 1) {
      name = singular;
    } else {
      name = plural;
    }
    String number;
    if (mode == QuantificationMode.NUMBER) {
      number = String.valueOf(quantity);
    } else {
      Numeral correspondingNumeral = Numeral.getCorrespondingNumeral(quantity);
      if (correspondingNumeral == null) {
        throw new AssertionError("Numeral.getCorrespondingNumeral() returned null!");
      } else {
        number = correspondingNumeral.toString().toLowerCase(Locale.ENGLISH);
      }
    }
    return number + " " + name;
  }

  @Override
  public boolean equals(Object object) {
    if (this == object) {
      return true;
    }
    if (object == null || getClass() != object.getClass()) {
      return false;
    }

    Name name = (Name) object;

    return singular.equals(name.singular) && plural.equals(name.plural);
  }

  @Override
  public int hashCode() {
    int result = singular.hashCode();
    result = 31 * result + plural.hashCode();
    return result;
  }

  @Override
  public String toString() {
    return getSingular();
  }

}