LongMapper.java

/*
 * Copyright 2008 Fedora Commons, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.mulgara.util;

/**
 * Objects of this type are used for mapping longs to longs. This can be easily met
 * with a Map<Long,Long>, or an IntFile, but this interface abstracts the interface
 * to allow manipulation of the number space if this is more efficient.
 *
 * @created Sep 26, 2008
 * @author Paula Gearon
 * @copyright © 2008 <a href="http://www.fedora-commons.org/">Fedora Commons</a>
 */
public interface LongMapper {

  /**
   * Map a long value to another value.
   * @param key The key.
   * @param value The value to map the key to.
   * @throws Exception An implementation specific error.
   */
  public void putLong(long key, long value) throws Exception;

  /**
   * Retrieve a long value, given a key.
   * @param key The key to look up with.
   * @return The value the key is mapped to, or 0 if it is not mapped to anything.
   * @throws Exception An implementation specific error.
   */
  public long getLong(long key) throws Exception;

  /**
   * Removes any resources associated with this mapper.
   * @throws Exception An implementation specific error.
   */
  public void delete() throws Exception;
}