Interface UniqueIdInterface

src/uid/UniqueIdInterface.java:39–93

Represents a table of Unique IDs, manages the lookup and creation of IDs. This interface is useless and deprecated. It provides no benefits and will be removed eventually. No new methods are added to this interface. Simply replace all uses of this interface with {@link Unique

 * implementation dependent.
 */
@Deprecated
public interface UniqueIdInterface {

  /**
   * Returns what kind of Unique ID is served by this instance.
   */
  String kind();

  /**
   * Returns the number of bytes on which each Unique ID is encoded.
   */
  short width();

  /**
   * Finds the name associated with a given ID.
   *
   * @param id The ID associated with that name.
   * @see #getId(String)
   * @see #getOrCreateId(String)
   * @throws NoSuchUniqueId if the given ID is not assigned.
   * @throws HBaseException if there is a problem communicating with HBase.
   * @throws IllegalArgumentException if the ID given in argument is encoded
   * on the wrong number of bytes.
   */
  String getName(byte[] id) throws NoSuchUniqueId, HBaseException;

  /**
   * Finds the ID associated with a given name.
   * <p>
   * The length of the byte array is fixed in advance by the implementation.
   *
   * @param name The name to lookup in the table.
   * @see #getName(byte[])
   * @return A non-null, non-empty {@code byte[]} array.
   * @throws NoSuchUniqueName if the name requested doesn't have an ID assigned.
   * @throws HBaseException if there is a problem communicating with HBase.
   * @throws IllegalStateException if the ID found in HBase is encoded on the
   * wrong number of bytes.
   */
  byte[] getId(String name) throws NoSuchUniqueName, HBaseException;

  /**
   * Finds the ID associated with a given name or creates it.
   * <p>
   * The length of the byte array is fixed in advance by the implementation.
   *
   * @param name The name to lookup in the table or to assign an ID to.
   * @throws HBaseException if there is a problem communicating with HBase.
   * @throws IllegalStateException if all possible IDs are already assigned.
   * @throws IllegalStateException if the ID found in HBase is encoded on the
   * wrong number of bytes.
   */
  byte[] getOrCreateId(String name) throws HBaseException, IllegalStateException;

}