PrefixTrie.java

/*
 * Copyright (C) 2018-2021 Niels Basjes
 *
 * 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
 *
 * https://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.wpilib.util.collections.prefixmap;
 
import java.util.Iterator;
import java.util.Objects;
import java.util.PrimitiveIterator;
 
interface PrefixTrie<V> {
  default V add(String prefix, V value) {
    Objects.requireNonNull(prefix, "The prefix may not be null");
    Objects.requireNonNull(value, "The value may not be null");
    return add(prefix.codePoints().iterator(), value);
  }

  V add(PrimitiveIterator.OfInt prefix, V value);
 
  // ====================================================

  default V remove(String prefix) {
    Objects.requireNonNull(prefix, "The prefix may not be null");
    return remove(prefix.codePoints().iterator());
  }

  default V remove(PrimitiveIterator.OfInt prefix) {
    throw new UnsupportedOperationException(
        "The 'remove(PrimitiveIterator.OfInt prefix)' method has not been implemented in "
            + this.getClass().getCanonicalName());
  }
 
  // ====================================================

  default boolean containsPrefix(String prefix) {
    return get(prefix) != null;
  }

  default boolean containsPrefix(PrimitiveIterator.OfInt prefix) {
    return get(prefix) != null;
  }
 
  // ====================================================

  default V get(String input) {
    Objects.requireNonNull(input, "The input may not be null");
    return get(input.codePoints().iterator());
  }

  V get(PrimitiveIterator.OfInt input);
 
  // ====================================================

  default V getShortestMatch(String input) {
    Objects.requireNonNull(input, "The input may not be null");
    return getShortestMatch(input.codePoints().iterator());
  }

  V getShortestMatch(PrimitiveIterator.OfInt input);
 
  // ====================================================

  default V getLongestMatch(String input) {
    Objects.requireNonNull(input, "The input may not be null");
    return getLongestMatch(input.codePoints().iterator());
  }

  V getLongestMatch(PrimitiveIterator.OfInt input);
 
  // ====================================================

  default Iterator<V> getAllMatches(String input) {
    Objects.requireNonNull(input, "The input may not be null");
    return getAllMatches(input.codePoints().iterator());
  }

  Iterator<V> getAllMatches(PrimitiveIterator.OfInt input);
 
  // ====================================================

  void clear();
}