Package org.jesterj.ingest.trie

Class UnmodifiableTrie<K,​V>

  • All Implemented Interfaces:
    java.io.Serializable, java.util.Map<K,​V>, java.util.SortedMap<K,​V>, org.apache.commons.collections4.Get<K,​V>, org.apache.commons.collections4.IterableGet<K,​V>, org.apache.commons.collections4.IterableMap<K,​V>, org.apache.commons.collections4.IterableSortedMap<K,​V>, org.apache.commons.collections4.OrderedMap<K,​V>, org.apache.commons.collections4.Put<K,​V>, org.apache.commons.collections4.Trie<K,​V>, org.apache.commons.collections4.Unmodifiable
    public class UnmodifiableTrie<K,​V>
extends java.lang.Object
implements org.apache.commons.collections4.Trie<K,​V>, java.io.Serializable, org.apache.commons.collections4.Unmodifiable
    An unmodifiable Trie.
    Since:
    4.0
    See Also:
    Serialized Form

    • Nested Class Summary

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

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Constructor Summary

      Constructors 
      Constructor Description
      UnmodifiableTrie​(org.apache.commons.collections4.Trie<K,​? extends V> trie)
      Constructor that wraps (not copies).

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clear()  
      java.util.Comparator<? super K> comparator()  
      boolean containsKey​(java.lang.Object key)  
      boolean containsValue​(java.lang.Object value)  
      java.util.Set<java.util.Map.Entry<K,​V>> entrySet()  
      boolean equals​(java.lang.Object obj)  
      K firstKey()  
      V get​(java.lang.Object key)  
      int hashCode()  
      java.util.SortedMap<K,​V> headMap​(K toKey)  
      boolean isEmpty()  
      java.util.Set<K> keySet()  
      K lastKey()  
      org.apache.commons.collections4.OrderedMapIterator<K,​V> mapIterator()  
      K nextKey​(K key)  
      java.util.SortedMap<K,​V> prefixMap​(K key)  
      K previousKey​(K key)  
      V put​(K key, V value)  
      void putAll​(java.util.Map<? extends K,​? extends V> m)  
      V remove​(java.lang.Object key)  
      int size()  
      java.util.SortedMap<K,​V> subMap​(K fromKey, K toKey)  
      java.util.SortedMap<K,​V> tailMap​(K fromKey)  
      java.lang.String toString()  
      static <K,​V>
      org.apache.commons.collections4.Trie<K,​V>      		 unmodifiableTrie​(org.apache.commons.collections4.Trie<K,​? extends V> trie)
      Factory method to create a unmodifiable trie.
      java.util.Collection<V> 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 Detail

      • UnmodifiableTrie

        public UnmodifiableTrie​(org.apache.commons.collections4.Trie<K,​? extends V> trie)
        Constructor that wraps (not copies).
        Parameters:
        trie - the trie to decorate, must not be null
        Throws:
        java.lang.NullPointerException - if trie is null

    • Method Detail

      • unmodifiableTrie

        public static <K,​V> org.apache.commons.collections4.Trie<K,​V> unmodifiableTrie​(org.apache.commons.collections4.Trie<K,​? extends V> trie)
        Factory method to create a 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:
        java.lang.NullPointerException - if trie is null

      • entrySet

        public java.util.Set<java.util.Map.Entry<K,​V>> entrySet()
        Specified by:
        entrySet in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        entrySet in interface java.util.Map<K,​V>
        Specified by:
        entrySet in interface java.util.SortedMap<K,​V>

      • keySet

        public java.util.Set<K> keySet()
        Specified by:
        keySet in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        keySet in interface java.util.Map<K,​V>
        Specified by:
        keySet in interface java.util.SortedMap<K,​V>

      • values

        public java.util.Collection<V> values()
        Specified by:
        values in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        values in interface java.util.Map<K,​V>
        Specified by:
        values in interface java.util.SortedMap<K,​V>

      • clear

        public void clear()
        Specified by:
        clear in interface java.util.Map<K,​V>
        Specified by:
        clear in interface org.apache.commons.collections4.Put<K,​V>

      • containsKey

        public boolean containsKey​(java.lang.Object key)
        Specified by:
        containsKey in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        containsKey in interface java.util.Map<K,​V>

      • containsValue

        public boolean containsValue​(java.lang.Object value)
        Specified by:
        containsValue in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        containsValue in interface java.util.Map<K,​V>

      • get

        public V get​(java.lang.Object key)
        Specified by:
        get in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        get in interface java.util.Map<K,​V>

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        isEmpty in interface java.util.Map<K,​V>

      • put

        public V put​(K key,
             V value)
        Specified by:
        put in interface java.util.Map<K,​V>
        Specified by:
        put in interface org.apache.commons.collections4.Put<K,​V>

      • putAll

        public void putAll​(java.util.Map<? extends K,​? extends V> m)
        Specified by:
        putAll in interface java.util.Map<K,​V>
        Specified by:
        putAll in interface org.apache.commons.collections4.Put<K,​V>

      • remove

        public V remove​(java.lang.Object key)
        Specified by:
        remove in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        remove in interface java.util.Map<K,​V>

      • size

        public int size()
        Specified by:
        size in interface org.apache.commons.collections4.Get<K,​V>
        Specified by:
        size in interface java.util.Map<K,​V>

      • firstKey

        public K firstKey()
        Specified by:
        firstKey in interface org.apache.commons.collections4.OrderedMap<K,​V>
        Specified by:
        firstKey in interface java.util.SortedMap<K,​V>

      • headMap

        public java.util.SortedMap<K,​V> headMap​(K toKey)
        Specified by:
        headMap in interface java.util.SortedMap<K,​V>

      • lastKey

        public K lastKey()
        Specified by:
        lastKey in interface org.apache.commons.collections4.OrderedMap<K,​V>
        Specified by:
        lastKey in interface java.util.SortedMap<K,​V>

      • subMap

        public java.util.SortedMap<K,​V> subMap​(K fromKey,
                                             K toKey)
        Specified by:
        subMap in interface java.util.SortedMap<K,​V>

      • tailMap

        public java.util.SortedMap<K,​V> tailMap​(K fromKey)
        Specified by:
        tailMap in interface java.util.SortedMap<K,​V>

      • prefixMap

        public java.util.SortedMap<K,​V> prefixMap​(K key)
        Specified by:
        prefixMap in interface org.apache.commons.collections4.Trie<K,​V>

      • comparator

        public java.util.Comparator<? super K> comparator()
        Specified by:
        comparator in interface java.util.SortedMap<K,​V>

      • mapIterator

        public org.apache.commons.collections4.OrderedMapIterator<K,​V> mapIterator()
        Specified by:
        mapIterator in interface org.apache.commons.collections4.IterableGet<K,​V>
        Specified by:
        mapIterator in interface org.apache.commons.collections4.OrderedMap<K,​V>

      • nextKey

        public K nextKey​(K key)
        Specified by:
        nextKey in interface org.apache.commons.collections4.OrderedMap<K,​V>

      • previousKey

        public K previousKey​(K key)
        Specified by:
        previousKey in interface org.apache.commons.collections4.OrderedMap<K,​V>

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map<K,​V>
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface java.util.Map<K,​V>
        Overrides:
        equals in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object