com.fireflysource.common.collection.trie.Trie Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of firefly-common Show documentation
The newest version!
package com.fireflysource.common.collection.trie;

import java.nio.ByteBuffer;
import java.util.Set;


/**
 * A Trie String lookup data structure.
 *
 * @param  the Trie entry type
 */
public interface Trie {

    /**
     * Put an entry into the Trie
     *
     * @param s The key for the entry
     * @param v The value of the entry
     * @return True if the Trie had capacity to add the field.
     */
    boolean put(String s, V v);

    /**
     * Put a value as both a key and a value.
     *
     * @param v The value and key
     * @return True if the Trie had capacity to add the field.
     */
    boolean put(V v);

    V remove(String s);

    /**
     * Get an exact match from a String key
     *
     * @param s The key
     * @return the value for the string key
     */
    V get(String s);

    /**
     * Get an exact match from a String key
     *
     * @param s      The key
     * @param offset The offset within the string of the key
     * @param len    the length of the key
     * @return the value for the string / offset / length
     */
    V get(String s, int offset, int len);

    /**
     * Get an exact match from a segment of a ByteBuufer as key
     *
     * @param b The buffer
     * @return The value or null if not found
     */
    V get(ByteBuffer b);

    /**
     * Get an exact match from a segment of a ByteBuufer as key
     *
     * @param b      The buffer
     * @param offset The offset within the buffer of the key
     * @param len    the length of the key
     * @return The value or null if not found
     */
    V get(ByteBuffer b, int offset, int len);

    /**
     * Get the best match from key in a String.
     *
     * @param s The string
     * @return The value or null if not found
     */
    V getBest(String s);

    /**
     * Get the best match from key in a String.
     *
     * @param s      The string
     * @param offset The offset within the string of the key
     * @param len    the length of the key
     * @return The value or null if not found
     */
    V getBest(String s, int offset, int len);

    /**
     * Get the best match from key in a byte array.
     * The key is assumed to by ISO_8859_1 characters.
     *
     * @param b      The buffer
     * @param offset The offset within the array of the key
     * @param len    the length of the key
     * @return The value or null if not found
     */
    V getBest(byte[] b, int offset, int len);

    /**
     * Get the best match from key in a byte buffer.
     * The key is assumed to by ISO_8859_1 characters.
     *
     * @param b      The buffer
     * @param offset The offset within the buffer of the key
     * @param len    the length of the key
     * @return The value or null if not found
     */
    V getBest(ByteBuffer b, int offset, int len);

    Set keySet();

    boolean isFull();

    boolean isCaseInsensitive();

    void clear();

}