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 map
- V- 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 SummaryConstructorsConstructorDescriptionUnmodifiableTrie(Trie<K, ? extends V> trie) Constructor that wraps (not copies).
- 
Method SummaryModifier 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.Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Mapcompute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
- 
Constructor Details- 
UnmodifiableTrieConstructor that wraps (not copies).- Parameters:
- trie- the trie to decorate, must not be null
- Throws:
- NullPointerException- if trie is null
 
 
- 
- 
Method Details- 
unmodifiableTrieFactory method to create an unmodifiable trie.- Type Parameters:
- K- the key type
- V- 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 interface- SortedMap<K,- V> 
 
- 
containsKeyDescription copied from interface:GetTests for presence of a given key.- Specified by:
- containsKeyin interface- Get<K,- V> 
- Specified by:
- containsKeyin interface- Map<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:
 
- 
containsValueDescription copied from interface:GetTests for presence of a given value.- Specified by:
- containsValuein interface- Get<K,- V> 
- Specified by:
- containsValuein interface- Map<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:
 
- 
entrySetDescription copied from interface:GetGets a set view of the mappings contained in this map.
- 
equals
- 
firstKey
- 
getDescription copied from interface:GetGets a value at a given key.
- 
hashCode
- 
headMap
- 
isEmpty
- 
keySetDescription copied from interface:GetGets a view of the keys contained in this map.
- 
lastKey
- 
mapIteratorDescription 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 interface- IterableGet<K,- V> 
- Specified by:
- mapIteratorin interface- OrderedMap<K,- V> 
- Returns:
- a map iterator
 
- 
nextKeyDescription copied from interface:OrderedMapGets the next key after the one specified.- Specified by:
- nextKeyin interface- OrderedMap<K,- V> 
- Parameters:
- key- the key to search for next from
- Returns:
- the next key, null if no match or at end
 
- 
prefixMapDescription 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'.
- 
previousKeyDescription copied from interface:OrderedMapGets the previous key before the one specified.- Specified by:
- previousKeyin interface- OrderedMap<K,- V> 
- Parameters:
- key- the key to search for previous from
- Returns:
- the previous key, null if no match or at start
 
- 
putDescription 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 interface- Map<K,- V> 
- Specified by:
- putin interface- Put<K,- V> 
- Parameters:
- key- key with which the specified value is to be associated
- value- 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
- 
removeDescription copied from interface:GetRemove a key-value mappings.
- 
size
- 
subMap
- 
tailMap
- 
toString
- 
valuesDescription copied from interface:GetGets a a collection view of the values contained in this map.
 
-