All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • ucar.units.UnitName Maven / Gradle / Ivy

    The newest version!
    /*
 * Copyright (c) 1998-2018 University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */
package ucar.units;

/**
 * Provides support for unit names.
 * 
 * @author Steven R. Emmerson
 */
public final class UnitName extends UnitID implements Comparable {
  private static final long serialVersionUID = 1L;

  /**
   * The name of the unit.
   * 
   * @serial
   */
  private final String name;

  /**
   * The plural form of the unit name.
   * 
   * @serial
   */
  private final String plural;

  /**
   * The symbol for the unit.
   * 
   * @serial
   */
  private final String symbol;

  /**
   * Constructs from a name and a symbol. Regular rules are use to construct
   * the plural form of the unit name.
   * 
   * @param name
   *        The name of the unit. Shall not be 
   *        null.
   * @param symbol
   *        The symbol for the unit. May be null
   *        .
   * @throws NameException
   *         name == null.
   */
  protected UnitName(final String name, final String symbol) throws NameException {
    this(name, null, symbol);
  }

  /**
   * Constructs from a name, a plural form of the unit name, and a symbol.
   * 
   * @param name
   *        The name of the unit. Shall not be 
   *        null.
   * @param plural
   *        The plural form of the name. May be 
   *        null, in which
   *        case regular plural- forming rules are used to construct the
   *        plural form from the name.
   * @param symbol
   *        The symbol for the unit. May be null
   *        .
   * @throws NameException
   *         name == null.
   */
  protected UnitName(final String name, final String plural, final String symbol) throws NameException {
    if (name == null) {
      throw new NameException("Unit name can't be null");
    }
    this.name = name;
    this.plural = plural == null ? makePlural(name) : plural;
    this.symbol = symbol;
  }

  /**
   * Factory method for constructing a UnitName from a name.
   * 
   * @param name
   *        The name of the unit. Shall not be 
   *        null.
   * @throws NameException
   *         name == null.
   */
  public static UnitName newUnitName(final String name) throws NameException {
    return newUnitName(name, null);
  }

  /**
   * Factory method for constructing a UnitName from a name and a plural form
   * of the name.
   * 
   * @param name
   *        The name of the unit. Shall not be 
   *        null.
   * @param plural
   *        The plural form of the name. May be 
   *        null, in which
   *        case regular plural- forming rules are used to construct the
   *        plural form from the name.
   * @throws NameException
   *         name == null.
   */
  public static UnitName newUnitName(final String name, final String plural) throws NameException {
    return newUnitName(name, plural, null);
  }

  /**
   * Factory method for constructing a UnitName from a name, a plural form of
   * the name, and a symbol.
   * 
   * @param name
   *        The name of the unit. Shall not be 
   *        null.
   * @param plural
   *        The plural form of the name. May be 
   *        null, in which
   *        case regular plural- forming rules are used to construct the
   *        plural form from the name.
   * @param symbol
   *        The symbol for the unit. May be null
   *        .
   * @throws NameException
   *         name == null.
   */
  public static UnitName newUnitName(final String name, final String plural, final String symbol) throws NameException {
    return new UnitName(name, plural, symbol);
  }

  /**
   * Returns the name.
   * 
   * @return The name. Won't be null.
   */
  @Override
  public final String getName() {
    return name;
  }

  /**
   * Returns the plural form of the unit name.
   * 
   * @return The plural form of the unit name.
   */
  @Override
  public String getPlural() {
    return plural;
  }

  /**
   * Returns the symbol.
   * 
   * @return The symbol. Might be null.
   */
  @Override
  public final String getSymbol() {
    return symbol;
  }

  /**
   * Returns the string representation of this identifier.
   * 
   * @return The string representation of this identifier.
   */
  @Override
  public final String toString() {
    final String string = getSymbol();
    return string == null ? getName() : string;
  }

  /**
   * Compares this UnitName with another UnitName.
   */
  public final int compareTo(final Object object) {
    return getName().compareToIgnoreCase(((UnitName) object).getName());
  }

  /**
   * Indicates if this UnitName is semantically identical to an object.
   */
  @Override
  public final boolean equals(final Object object) {
    return object instanceof UnitName && compareTo(object) == 0;
  }

  /**
   * Returns the hash code of this instance.
   * 
   * @return The hash code of this instance.
   */
  @Override
  public int hashCode() {
    return getName().toLowerCase().hashCode();
  }

  /**
   * Returns the plural form of a name. Regular rules are used to generate the
   * plural form.
   * 
   * @param name
   *        The name.
   * @return The plural form of the name.
   */
  protected String makePlural(final String name) {
    String plural;
    final int length = name.length();
    final char lastChar = name.charAt(length - 1);
    if (lastChar != 'y') {
      plural = name + (lastChar == 's' || lastChar == 'x' || lastChar == 'z' || name.endsWith("ch") ? "es" : "s");
    } else {
      if (length == 1) {
        plural = name + "s";
      } else {
        final char penultimateChar = name.charAt(length - 2);
        plural = (penultimateChar == 'a' || penultimateChar == 'e' || penultimateChar == 'i' || penultimateChar == 'o'
            || penultimateChar == 'u') ? name + "s" : name.substring(0, length - 1) + "ies";
      }
    }
    return plural;
  }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy