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
ConstructorsConstructorDescriptionUnmodifiableTrie(Trie<K, ? extends V> trie) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Removes all of the mappings from this map.Comparator<? super K> booleancontainsKey(Object key) Tests for presence of a given key.booleancontainsValue(Object value) Tests for presence of a given value.entrySet()Gets a set view of the mappings contained in this map.booleanfirstKey()Gets the first key currently in this map.Gets a value at a given key.inthashCode()booleanisEmpty()Tests whether this instance contains any key-value mappings.keySet()Gets a view of the keys contained in this map.lastKey()Gets the last key currently in this map.Obtains anOrderedMapIteratorover the map.Gets the next key after the one specified.Returns a view of thisTrieof all elements that are prefixed by the given key.previousKey(K key) Gets the previous key before the one specified.Associates the specified value with the specified key in this map.voidCopies all of the mappings from the specified map to this map.Remove a key-value mappings.intsize()Gets the number of key-value mappings in this map.toString()static <K,V> Trie <K, V> unmodifiableTrie(Trie<K, ? extends V> trie) Factory method to create an unmodifiable trie.values()Gets a a collection view of the values contained in this map.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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:
comparatorin interfaceSortedMap<K,V>
-
containsKey
Description copied from interface:GetTests for presence of a given key.- Specified by:
containsKeyin interfaceGet<K,V> - Specified by:
containsKeyin interfaceMap<K,V> - Parameters:
key- key whose presence in this map is to be tested- Returns:
trueif this map contains a mapping for the specified key- See Also:
-
containsValue
Description copied from interface:GetTests for presence of a given value.- Specified by:
containsValuein interfaceGet<K,V> - Specified by:
containsValuein interfaceMap<K,V> - Parameters:
value- value whose presence in this map is to be tested- Returns:
trueif this map maps one or more keys to the specified value- See Also:
-
entrySet
Description copied from interface:GetGets a set view of the mappings contained in this map. -
equals
-
firstKey
-
get
Description copied from interface:GetGets a value at a given key. -
hashCode
-
headMap
-
isEmpty
-
keySet
Description copied from interface:GetGets a view of the keys contained in this map. -
lastKey
-
mapIterator
Description copied from interface:OrderedMapObtains anOrderedMapIteratorover the map.An ordered map iterator is an efficient way of iterating over maps in both directions.
- Specified by:
mapIteratorin interfaceIterableGet<K,V> - Specified by:
mapIteratorin interfaceOrderedMap<K,V> - Returns:
- a map iterator
-
nextKey
Description copied from interface:OrderedMapGets the next key after the one specified.- Specified by:
nextKeyin 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:TrieReturns a view of thisTrieof all elements that are prefixed by the given key.In a
Triewith fixed size keys, this is essentially aMap.get(Object)operation.For example, if the
Triecontains 'Anna', 'Anael', 'Analu', 'Andreas', 'Andrea', 'Andres', and 'Anatole', then a lookup of 'And' would return 'Andreas', 'Andrea', and 'Andres'. -
previousKey
Description copied from interface:OrderedMapGets the previous key before the one specified.- Specified by:
previousKeyin 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:PutAssociates the specified value with the specified key in this map.Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.
- Specified by:
putin interfaceMap<K,V> - Specified by:
putin 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, ornullif there was no mapping forkey. (Anullreturn can also indicate that the map previously associatednullwithkey, if the implementation supportsnullvalues.) - See Also:
-
putAll
-
remove
Description copied from interface:GetRemove a key-value mappings. -
size
-
subMap
-
tailMap
-
toString
-
values
Description copied from interface:GetGets a a collection view of the values contained in this map.
-