org.eclipse.jetty.util.Trie Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
There is a newer version: 2024.9.17689.20240905T073330Z-240800
// 
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
// 
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
// 
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
// 
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
// 
package org.eclipse.jetty.util;

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

/**
 *  A Trie String lookup data structure.
 *
 *  @param  the Trie entry type
 *
 * @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
 */
@Deprecated(since = "2021-05-27")
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);

    default V getBest(byte[] b) {
        return getBest(b, 0, b.length);
    }

    /**
     * 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);

    default V getBest(ByteBuffer b) {
        return getBest(b, 0, b.remaining());
    }

    Set keySet();

    boolean isFull();

    boolean isCaseInsensitive();

    void clear();

    static  Trie empty(final boolean caseInsensitive) {
        return new Trie() {

            @Override
            public boolean put(String s, Object o) {
                return false;
            }

            @Override
            public boolean put(Object o) {
                return false;
            }

            @Override
            public T remove(String s) {
                return null;
            }

            @Override
            public T get(String s) {
                return null;
            }

            @Override
            public T get(String s, int offset, int len) {
                return null;
            }

            @Override
            public T get(ByteBuffer b) {
                return null;
            }

            @Override
            public T get(ByteBuffer b, int offset, int len) {
                return null;
            }

            @Override
            public T getBest(String s) {
                return null;
            }

            @Override
            public T getBest(String s, int offset, int len) {
                return null;
            }

            @Override
            public T getBest(byte[] b, int offset, int len) {
                return null;
            }

            @Override
            public T getBest(ByteBuffer b, int offset, int len) {
                return null;
            }

            @Override
            public Set keySet() {
                return Collections.emptySet();
            }

            @Override
            public boolean isFull() {
                return true;
            }

            @Override
            public boolean isCaseInsensitive() {
                return caseInsensitive;
            }

            @Override
            public void clear() {
            }
        };
    }
}