Interface DataContainer<K,​V>

  • All Superinterfaces:
    java.lang.Iterable<InternalCacheEntry<K,​V>>
    All Known Implementing Classes:
    org.infinispan.container.impl.AbstractDelegatingDataContainer, org.infinispan.container.impl.AbstractDelegatingInternalDataContainer, org.infinispan.container.impl.AbstractInternalDataContainer, BoundedOffHeapDataContainer, OffHeapDataContainer, SegmentedBoundedOffHeapDataContainer

    public interface DataContainer<K,​V>
    extends java.lang.Iterable<InternalCacheEntry<K,​V>>
    The main internal data structure which stores entries. Care should be taken when using this directly as entries could be stored in a different way than they were given to a Cache. If you wish to convert entries to the stored format, you should use the provided DataConversion such as
     cache.getAdvancedCache().getKeyDataConversion().toStorage(key);
     
    when dealing with keys or the following when dealing with values
     cache.getAdvancedCache().getValueDataConversion().toStorage(value);
     
    You can also convert from storage to the user provided type by using the DataConversion.fromStorage(Object) method on any value returned from the DataContainer
    Since:
    4.0
    Author:
    Manik Surtani (manik@jboss.org), Galder ZamarreƱo, Vladimir Blagojevic
    • Method Detail

      • get

        @Deprecated
        InternalCacheEntry<K,​V> get​(java.lang.Object k)
        Deprecated.
        since 10.1 - Please use peek(Object) instead.
        Retrieves a cached entry
        Parameters:
        k - key under which entry is stored
        Returns:
        entry, if it exists and has not expired, or null if not
      • peek

        InternalCacheEntry<K,​V> peek​(java.lang.Object k)
        Retrieves a cache entry in the same way as get(Object)} except that it does not update or reorder any of the internal constructs. I.e., expiration does not happen, and in the case of the LRU container, the entry is not moved to the end of the chain.

        This method should be used instead of get(Object)} when called while iterating through the data container using methods like iterator() to avoid changing the underlying collection's order.

        Parameters:
        k - key under which entry is stored
        Returns:
        entry, if it exists, or null if not
      • put

        void put​(K k,
                 V v,
                 Metadata metadata)
        Puts an entry in the cache along with metadata adding information such lifespan of entry, max idle time, version information...etc.

        The key must be activate by invoking ActivationManager.onUpdate(Object, boolean).

        Parameters:
        k - key under which to store entry
        v - value to store
        metadata - metadata of the entry
      • containsKey

        boolean containsKey​(java.lang.Object k)
        Tests whether an entry exists in the container
        Parameters:
        k - key to test
        Returns:
        true if entry exists and has not expired; false otherwise
      • size

        default int size()
        Returns:
        count of the number of entries in the container excluding expired entries
      • sizeIncludingExpired

        int sizeIncludingExpired()
        Returns:
        count of the number of entries in the container including expired entries
      • clear

        void clear()
        Removes all entries in the container
      • keySet

        @Deprecated
        default java.util.Set<K> keySet()
        Deprecated.
        Please use iterator method if bulk operations are required.
        Returns a set of keys in the container. When iterating through the container using this method, clients should never call get(Object) method but instead peek(Object), in order to avoid changing the order of the underlying collection as a side of effect of iterating through it.

        This set of keys will include expired entries. If you wish to only retrieve non expired keys please use the iterator() method and retrieve keys from there.

        Returns:
        a set of keys
      • values

        @Deprecated
        default java.util.Collection<V> values()
        Deprecated.
        Please use iterator method if bulk operations are required.
        This returns all values in the container including expired entries. If you wish to only receive values that are not expired it is recommended to use entrySet() and pull values from there directly.
        Returns:
        a set of values contained in the container
      • entrySet

        @Deprecated
        default java.util.Set<InternalCacheEntry<K,​V>> entrySet()
        Deprecated.
        Please use iterator method if bulk operations are required.
        Returns a mutable set of immutable cache entries exposed as immutable Map.Entry instances. Clients of this method such as Cache.entrySet() operation implementors are free to convert the set into an immutable set if needed, which is the most common use case.

        If a client needs to iterate through a mutable set of mutable cache entries, it should iterate the container itself rather than iterating through the return of entrySet().

        This set is a read only backed view of the entries underneath. This set will only show non expired entries when invoked. The size method of the set will count expired entries for the purpose of having a O(1) time cost compared to O(N) if it is to not count expired entries.

        Returns:
        a set of immutable cache entries
      • executeTask

        @Deprecated
        default void executeTask​(KeyFilter<? super K> filter,
                                 java.util.function.BiConsumer<? super K,​InternalCacheEntry<K,​V>> action)
                          throws java.lang.InterruptedException
        Deprecated.
        since 9.3 Please use the iterator() method and apply filtering manually
        Executes task specified by the given action on the container key/values filtered using the specified key filter.
        Parameters:
        filter - the filter for the container keys
        action - the specified action to execute on filtered key/values
        Throws:
        java.lang.InterruptedException
      • executeTask

        @Deprecated
        default void executeTask​(KeyValueFilter<? super K,​? super V> filter,
                                 java.util.function.BiConsumer<? super K,​InternalCacheEntry<K,​V>> action)
                          throws java.lang.InterruptedException
        Deprecated.
        since 9.3 Please use the iterator() method and apply filtering manually
        Executes task specified by the given action on the container key/values filtered using the specified keyvalue filter.
        Parameters:
        filter - the filter for the container key/values
        action - the specified action to execute on filtered key/values
        Throws:
        java.lang.InterruptedException
      • iterator

        java.util.Iterator<InternalCacheEntry<K,​V>> iterator()

        This iterator only returns entries that are not expired, however it will not remove them while doing so.

        Specified by:
        iterator in interface java.lang.Iterable<K>
        Returns:
        iterator that doesn't produce expired entries
      • spliterator

        default java.util.Spliterator<InternalCacheEntry<K,​V>> spliterator()

        This spliterator only returns entries that are not expired, however it will not remove them while doing so.

        Specified by:
        spliterator in interface java.lang.Iterable<K>
        Returns:
        spliterator that doesn't produce expired entries
      • iteratorIncludingExpired

        java.util.Iterator<InternalCacheEntry<K,​V>> iteratorIncludingExpired()
        Same as iterator() except that is also returns expired entries.
        Returns:
        iterator that returns all entries including expired ones
      • spliteratorIncludingExpired

        default java.util.Spliterator<InternalCacheEntry<K,​V>> spliteratorIncludingExpired()
        Same as spliterator() except that is also returns expired entries.
        Returns:
        spliterator that returns all entries including expired ones
      • resize

        default void resize​(long newSize)
        Resizes the capacity of the underlying container. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise.
        Parameters:
        newSize - the new size
      • capacity

        default long capacity()
        Returns the capacity of the underlying container. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise.
        Returns:
      • evictionSize

        default long evictionSize()
        Returns how large the eviction size is currently. This is only supported if the container is bounded. An UnsupportedOperationException is thrown otherwise. This value will always be lower than the value returned from capacity()
        Returns:
        how large the counted eviction is