Class UnmodifiableTrie<K,V>
java.lang.Object
org.apache.commons.collections4.trie.UnmodifiableTrie<K,V>
- Type Parameters:
K
- the type of the keys in this mapV
- the type of the values in this map
- All Implemented Interfaces:
Serializable
,Map<K,
,V> SortedMap<K,
,V> Get<K,
,V> IterableGet<K,
,V> IterableMap<K,
,V> IterableSortedMap<K,
,V> OrderedMap<K,
,V> Put<K,
,V> Trie<K,
,V> Unmodifiable
An unmodifiable
Trie
.- Since:
- 4.0
- See Also:
-
Nested Class Summary
-
Constructor Summary
ConstructorDescriptionUnmodifiableTrie
(Trie<K, ? extends V> trie) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
Comparator<? super K>
boolean
containsKey
(Object key) boolean
containsValue
(Object value) entrySet()
boolean
firstKey()
Gets the first key currently in this map.int
hashCode()
boolean
isEmpty()
keySet()
lastKey()
Gets the last key currently in this map.Obtains anOrderedMapIterator
over the map.Gets the next key after the one specified.Returns a view of thisTrie
of all elements that are prefixed by the given key.previousKey
(K key) Gets the previous key before the one specified.Note that the return type is Object, rather than V as in the Map interface.void
int
size()
toString()
static <K,
V> Trie<K, V> unmodifiableTrie
(Trie<K, ? extends V> trie) Factory method to create an unmodifiable trie.values()
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
Constructor Details
-
UnmodifiableTrie
Constructor that wraps (not copies).- Parameters:
trie
- the trie to decorate, must not be null- Throws:
NullPointerException
- if trie is null
-
-
Method Details
-
unmodifiableTrie
Factory method to create an unmodifiable trie.- Type Parameters:
K
- the key typeV
- the value type- Parameters:
trie
- the trie to decorate, must not be null- Returns:
- a new unmodifiable trie
- Throws:
NullPointerException
- if trie is null
-
clear
-
comparator
- Specified by:
comparator
in interfaceSortedMap<K,
V>
-
containsKey
- Specified by:
containsKey
in interfaceGet<K,
V> - Specified by:
containsKey
in interfaceMap<K,
V> - Parameters:
key
- key whose presence in this map is to be tested- Returns:
true
if this map contains a mapping for the specified key- See Also:
-
containsValue
- Specified by:
containsValue
in interfaceGet<K,
V> - Specified by:
containsValue
in interfaceMap<K,
V> - Parameters:
value
- value whose presence in this map is to be tested- Returns:
true
if this map maps one or more keys to the specified value- See Also:
-
entrySet
-
equals
-
firstKey
Description copied from interface:OrderedMap
Gets the first key currently in this map. -
get
-
hashCode
-
headMap
-
isEmpty
-
keySet
-
lastKey
Description copied from interface:OrderedMap
Gets the last key currently in this map. -
mapIterator
Description copied from interface:OrderedMap
Obtains anOrderedMapIterator
over the map.An ordered map iterator is an efficient way of iterating over maps in both directions.
- Specified by:
mapIterator
in interfaceIterableGet<K,
V> - Specified by:
mapIterator
in interfaceOrderedMap<K,
V> - Returns:
- a map iterator
-
nextKey
Description copied from interface:OrderedMap
Gets the next key after the one specified.- Specified by:
nextKey
in interfaceOrderedMap<K,
V> - Parameters:
key
- the key to search for next from- Returns:
- the next key, null if no match or at end
-
prefixMap
Description copied from interface:Trie
Returns a view of thisTrie
of all elements that are prefixed by the given key.In a
Trie
with fixed size keys, this is essentially aMap.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'. -
previousKey
Description copied from interface:OrderedMap
Gets the previous key before the one specified.- Specified by:
previousKey
in interfaceOrderedMap<K,
V> - Parameters:
key
- the key to search for previous from- Returns:
- the previous key, null if no match or at start
-
put
Description copied from interface:Put
Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.- Specified by:
put
in interfaceMap<K,
V> - Specified by:
put
in interfacePut<K,
V> - Parameters:
key
- key with which the specified value is to be associatedvalue
- value to be associated with the specified key- Returns:
- the previous value associated with
key
, ornull
if there was no mapping forkey
. (Anull
return can also indicate that the map previously associatednull
withkey
, if the implementation supportsnull
values.) - See Also:
-
putAll
-
remove
-
size
-
subMap
-
tailMap
-
toString
-
values
-