Package org.apache.commons.collections4

# Interface Trie<K,V>

Type Parameters:
  `K` - The type of the keys in this map.
  `V` - The type of the values in this map.

All Superinterfaces:
  `Get<K,V>`, `IterableGet<K,V>`, `IterableMap<K,V>`, `IterableSortedMap<K,V>`, `Map<K,V>`, `OrderedMap<K,V>`, `Put<K,V>`, `SortedMap<K,V>`

All Known Implementing Classes:
  `AbstractBitwiseTrie`, `AbstractPatriciaTrie`, `PatriciaTrie`, `UnmodifiableTrie`

public interface Trie<K,V> extends IterableSortedMap<K,V>
Defines the interface for a prefix tree, an ordered tree data structure. For more information, see Tries.

Since:
  4.0

- ## Nested Class Summary

  ## Nested classes/interfaces inherited from interface java.util.Map

  `Map.Entry<K,V>`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `SortedMap<K,V>`
  `prefixMap(K key)`
  Returns a view of this `Trie` of all elements that are prefixed by the given key.

  ### Methods inherited from interface org.apache.commons.collections4.Get

  `containsKey, containsValue, entrySet, get, isEmpty, keySet, remove, size, values`

  ### Methods inherited from interface java.util.Map

  `clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size`

  ### Methods inherited from interface org.apache.commons.collections4.OrderedMap

  `firstKey, lastKey, mapIterator, nextKey, previousKey`

  ### Methods inherited from interface org.apache.commons.collections4.Put

  `clear, put, putAll`

  ### Methods inherited from interface java.util.SortedMap

  `comparator, entrySet, firstKey, headMap, keySet, lastKey, subMap, tailMap, values`

- ## Method Details

  - ### prefixMap

    SortedMap<K,V> prefixMap(K key)
    Returns a view of this `Trie` of all elements that are prefixed by the given key.

    In a `Trie` with fixed size keys, this is essentially a `Map.get(Object)` operation.

    For example, if the `Trie` contains 'Anna', 'Anael', 'Analu', 'Andreas', 'Andrea', 'Andres', and 'Anatole', then a lookup of 'And' would return 'Andreas', 'Andrea', and 'Andres'.

    Parameters:
      `key` - The key used in the search.
    Returns:
      A `SortedMap` view of this `Trie` with all elements whose key is prefixed by the search key.