Package net.sf.ehcache.store

Class CacheKeySet<E>

  • Type Parameters:
    E - the type of elements maintained by this set
    All Implemented Interfaces:
    java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>
    public class CacheKeySet<E>
extends java.lang.Object
implements java.util.Set<E>
    A Set of keys that will encapsulate keys present in a Cache. It will mostly behave as an immutable Set, but for its size() method
    Author:
    Alex Snaps

    • Constructor Summary

      Constructors 
      Constructor Description
      CacheKeySet​(java.util.Collection<E>... keySets)
      Create a new Set for all tiers in the cache.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(java.lang.Object o)
      You can't add to this set, will throw!
      boolean addAll​(java.util.Collection c)
      You can't add to this set, will throw!
      void clear()
      You can't remove from this set, will throw!
      boolean contains​(java.lang.Object o)
      boolean containsAll​(java.util.Collection<?> c)
      boolean isEmpty()
      java.util.Iterator<E> iterator()
      boolean remove​(java.lang.Object o)
      You can't remove from this set, will throw!
      boolean removeAll​(java.util.Collection<?> c)
      You can't remove from this set, will throw!
      boolean retainAll​(java.util.Collection<?> c)
      You can't remove from this set, will throw!
      int size()
      Sums the size of all sets wrapped by this one, so this will not account for duplicated keys.
      java.lang.Object[] toArray()
      <T> T[] toArray​(T[] a)

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface java.util.Collection

        parallelStream, removeIf, stream, toArray

      • Methods inherited from interface java.lang.Iterable

        forEach

      • Methods inherited from interface java.util.Set

        equals, hashCode, spliterator

    • Constructor Detail

      • CacheKeySet

        public CacheKeySet​(java.util.Collection<E>... keySets)
        Create a new Set for all tiers in the cache. Generally, you'd pass the authority's keySet, and higher layer pinned keySets
        Parameters:
        keySets - an array of keySets

    • Method Detail

      • size

        public int size()
        Sums the size of all sets wrapped by this one, so this will not account for duplicated keys. Like for in-memory pinned keys, that might also present in lower tiers: e.g. DiskStore when its capacity isn't reached.
        Specified by:
        size in interface java.util.Collection<E>
        Specified by:
        size in interface java.util.Set<E>
        Returns:
        the sum of all keySet sizes

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface java.util.Collection<E>
        Specified by:
        isEmpty in interface java.util.Set<E>

      • contains

        public boolean contains​(java.lang.Object o)
        Specified by:
        contains in interface java.util.Collection<E>
        Specified by:
        contains in interface java.util.Set<E>

      • iterator

        public java.util.Iterator<E> iterator()
        Specified by:
        iterator in interface java.util.Collection<E>
        Specified by:
        iterator in interface java.lang.Iterable<E>
        Specified by:
        iterator in interface java.util.Set<E>

      • toArray

        public java.lang.Object[] toArray()
        Specified by:
        toArray in interface java.util.Collection<E>
        Specified by:
        toArray in interface java.util.Set<E>

      • toArray

        public <T> T[] toArray​(T[] a)
        Specified by:
        toArray in interface java.util.Collection<E>
        Specified by:
        toArray in interface java.util.Set<E>

      • add

        public boolean add​(java.lang.Object o)
        You can't add to this set, will throw!
        Specified by:
        add in interface java.util.Collection<E>
        Specified by:
        add in interface java.util.Set<E>
        Throws:
        java.lang.UnsupportedOperationException

      • remove

        public boolean remove​(java.lang.Object o)
        You can't remove from this set, will throw!
        Specified by:
        remove in interface java.util.Collection<E>
        Specified by:
        remove in interface java.util.Set<E>
        Throws:
        java.lang.UnsupportedOperationException

      • containsAll

        public boolean containsAll​(java.util.Collection<?> c)
        Specified by:
        containsAll in interface java.util.Collection<E>
        Specified by:
        containsAll in interface java.util.Set<E>

      • addAll

        public boolean addAll​(java.util.Collection c)
        You can't add to this set, will throw!
        Specified by:
        addAll in interface java.util.Collection<E>
        Specified by:
        addAll in interface java.util.Set<E>
        Throws:
        java.lang.UnsupportedOperationException

      • removeAll

        public boolean removeAll​(java.util.Collection<?> c)
        You can't remove from this set, will throw!
        Specified by:
        removeAll in interface java.util.Collection<E>
        Specified by:
        removeAll in interface java.util.Set<E>
        Throws:
        java.lang.UnsupportedOperationException

      • retainAll

        public boolean retainAll​(java.util.Collection<?> c)
        You can't remove from this set, will throw!
        Specified by:
        retainAll in interface java.util.Collection<E>
        Specified by:
        retainAll in interface java.util.Set<E>
        Throws:
        java.lang.UnsupportedOperationException

      • clear

        public void clear()
        You can't remove from this set, will throw!
        Specified by:
        clear in interface java.util.Collection<E>
        Specified by:
        clear in interface java.util.Set<E>
        Throws:
        java.lang.UnsupportedOperationException