Caching
=======

OkHttp implements an optional, off by default, Cache. OkHttp aims for RFC correct and
pragmatic caching behaviour, following common real-world browser like Firefox/Chrome and 
server behaviour when ambiguous.

# Basic Usage

```kotlin
  private val client: OkHttpClient = OkHttpClient.Builder()
      .cache(Cache(
          directory = File(application.cacheDir, "http_cache"),
          // $0.05 worth of phone storage in 2020

  - pymdownx.tabbed:
      alternate_style: true
  - tables

plugins:
  - search
  - redirects:
      redirect_maps:
        # Redirect all feature pages to features/*
        'caching.md': 'features/caching.md'
        'calls.md': 'features/calls.md'
        'connections.md': 'features/connections.md'
        'events.md': 'features/events.md'
        'https.md': 'features/events.md'

 * under the License.
 */

/**
 * Provides a caching infrastructure for Maven requests and their results.
 * <p>
 * This package contains the core components for implementing and managing caches in Maven:
 * <ul>
 *   <li>{@link org.apache.maven.api.cache.RequestCache} - The main interface for caching request results</li>

import org.apache.maven.api.annotations.Experimental;
import org.apache.maven.api.services.Request;
import org.apache.maven.api.services.Result;

/**
 * Interface for caching request results in Maven. This cache implementation provides
 * methods for executing and optionally caching both single requests and batches of requests.
 * <p>
 * The cache behavior is determined by the cache retention specified in the request's metadata.

#
# Maven Cache Configuration
#
# Controls caching behavior for different request types during Maven builds.
# Format: RequestType { scope:SCOPE ref:REFERENCE_TYPE }
#
# SCOPE OPTIONS:
#   session - Cache for entire Maven session (all modules in multi-module build)
#   request - Cache only for current request + its child requests
#   none    - Disable caching entirely
#
# REFERENCE OPTIONS:

     * - Build-wide configuration
     * - Project model caching
     * - Inter-module metadata
     */
    SESSION_SCOPED,

    /**
     * Data should only be retained for the current build request.
     * Suitable for:
     * - Plugin execution results
     * - Temporary build artifacts
     * - Phase-specific data
     */
    REQUEST_SCOPED,

    /**
     * Caching should be disabled for this data.
     * Suitable for:

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.Map;
import org.jspecify.annotations.Nullable;

/**
 * A {@link MapIteratorCache} that adds additional caching. In addition to the caching provided by
 * {@link MapIteratorCache}, this structure caches values for the two most recently retrieved keys.
 *
 * @author James Sexton
 */
final class MapRetrievalCache<K, V> extends MapIteratorCache<K, V> {

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.Map;
import org.jspecify.annotations.Nullable;

/**
 * A {@link MapIteratorCache} that adds additional caching. In addition to the caching provided by
 * {@link MapIteratorCache}, this structure caches values for the two most recently retrieved keys.
 *
 * @author James Sexton
 */
final class MapRetrievalCache<K, V> extends MapIteratorCache<K, V> {

	// Parameters:
	//   ctx: The context for the request, which can carry deadlines, cancellation signals, etc.
	//   key: The key representing the SQL query, used for caching and preparing the statement.
	//   isTransaction: Indicates whether this operation is part of a transaction, which may affect the caching strategy.
	//   connPool: A connection pool that provides database connections.

org.gradle.caching=true
org.gradle.parallel=true

android.useAndroidX=true
kotlin.mpp.applyDefaultHierarchyTemplate=false

androidBuild=false
graalBuild=false
loomBuild=false
containerTests=false