ucar.units.PrefixName Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.gecko.ucar.units Show documentation

Re-packaged Unidata udUnits

The newest version!

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

import javax.annotation.concurrent.Immutable;

/**
 * Provides support for prefix names and numeric values.
 *
 * Instances of this class are immutable.
 *
 * @author Steven R. Emmerson
 */
@Immutable

public final class PrefixName extends Prefix {
  /**
   * Constructs from a name and a numeric value.
   * 
   * @param name The name for the prefix.
   * @param value The numeric value for the prefix.
   */
  public PrefixName(String name, double value) {
    super(name, value);
  }

  /**
   * Compares this PrefixName with another PrefixName.
   * 
   * @param obj The other PrefixName.
   * @return A negative value, zero, or a positive value
   *         depending on whether this PrefixName is less
   *         than, equal to, or greater than 
   *        obj, respectively.
   */
  public final int compareTo(Object obj) {
    return getID().compareToIgnoreCase(((PrefixName) obj).getID());
  }

  /**
   * Compares this PrefixName with a string.
   * 
   * @param string The string to compare this PrefixName against.
   * @return A negative value, zero, or a positive value
   *         depending on whether this PrefixName is less
   *         than, equal to, or greater than 
   *        string, respectively.
   */
  public final int compareTo(String string) {
    return getID().length() >= string.length() ? getID().compareToIgnoreCase(string)
        : getID().compareToIgnoreCase(string.substring(0, getID().length()));
  }
}