net.openhft.collections.IntIntMultiMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of collections Show documentation

Java Collections which are designed to be huge (may GB)

There is a newer version: 3.2.2

/*
 * Copyright 2013 Peter Lawrey
 *
 * 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 net.openhft.collections;

/**
 * This is only used to store keys and positions, but it could store int/int key/values for another purpose.
 */
interface IntIntMultiMap {
    /**
     * Add an entry.  Allow duplicate hashes, but not key/position pairs.
     *
     * @param key   to add
     * @param value to add
     */
    void put(int key, int value);

    /**
     * Add an entry.  Allow duplicate hashes, but not key/position pairs.
     *
     * @param key   to add
     * @param value to add
     * @param limit count of how many attempts to add the key value before you give up.
     * @return true if added, false if not.
     */
    boolean putLimited(int key, int value, int limit);

    /**
     * Remove a key/value pair.
     *
     * @param key   to remove
     * @param value to remove
     * @return whether a match was found.
     */
    boolean remove(int key, int value);

    /**
     * Used for start a search for a given key
     *
     * @return normalized key value, better to be used in subsequent calls
     */
    int startSearch(int key);

    /**
     * Used for getting the next position for a given key
     *
     * @return the next position for the last search or negative value
     */
    int nextPos();

    /**
     * Used for finding the first entry
     *
     * @return the first position in the map, -1 otherwise
     */
    int firstPos(); //todo: this method doesn't fit nicely in the picture

    /**
     * Used for finding the next key after a given key.
     *
     * @param key to find a next key after.
     * @return the next non-empty position
     */
    int nextKeyAfter(int key); //todo: this method doesn't fit nicely in the picture

    void clear();
}