org.eclipse.aether

## Interface RepositoryCache

- All Known Implementing Classes:
    DefaultRepositoryCache

      public interface RepositoryCache

  Caches auxiliary data used during repository access like already processed metadata. The data in the cache is meant for exclusive consumption by the repository system and is opaque to the cache implementation. Note: Actual cache implementations must be thread-safe.
  See Also:
    `RepositorySystemSession.getCache()`

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Object` | `get(RepositorySystemSession session, Object key)` Gets the specified data from the cache.
    `void` | `put(RepositorySystemSession session, Object key, Object data)` Puts the specified data into the cache.

- - ### Method Detail

    - #### put

          void put(RepositorySystemSession session,
                 Object key,
                 Object data)

      Puts the specified data into the cache. It is entirely up to the cache implementation how long this data will be kept before being purged, i.e. callers must not make any assumptions about the lifetime of cached data.

      Warning: The cache will directly save the provided reference. If the cached data is mutable, i.e. could be modified after being put into the cache, the caller is responsible for creating a copy of the original data and store the copy in the cache.

      Parameters:
        `session` - The repository session during which the cache is accessed, must not be `null`.
        `key` - The key to use for lookup of the data, must not be `null`.
        `data` - The data to store in the cache, may be `null`.

    - #### get

          Object get(RepositorySystemSession session,
                   Object key)

      Gets the specified data from the cache.

      Warning: The cache will directly return the saved reference. If the cached data is to be modified after its retrieval, the caller is responsible to create a copy of the returned data and use this instead of the cache record.

      Parameters:
        `session` - The repository session during which the cache is accessed, must not be `null`.
        `key` - The key to use for lookup of the data, must not be `null`.
      Returns:
        The requested data or `null` if none was present in the cache.

Copyright © 2010-2014 The Eclipse Foundation. All Rights Reserved.