Package com.gradle.develocity.agent.maven.api.cache

Interface LocalBuildCache

public interface LocalBuildCache
Configures the local build cache.

The specified values will take precedence over the values defined in the develocity.xml.

Since:
1.21

  • Method Summary

    Modifier and Type
    Method
    Description
    CleanupPolicy
    getCleanupPolicy()
    Gets the cleanup policy configuration.
    File
    getDirectory()
    Gets the local build cache directory.
    boolean
    isEnabled()
    Whether the local build cache is enabled.
    boolean
    isStoreEnabled()
    Whether storing build cache entries is enabled.
    void
    setDirectory(File directory)
    Sets the local build cache directory.
    void
    setEnabled(boolean enabled)
    Sets whether to enable the local build cache.
    void
    setStoreEnabled(boolean storeEnabled)
    Sets whether to store build cache entries.

  • Method Details

    • isEnabled

      boolean isEnabled()
      Whether the local build cache is enabled.
      Returns:
      true if the local build cache is enabled, false otherwise

    • setEnabled

      void setEnabled(boolean enabled)
      Sets whether to enable the local build cache.

      Configuration via the develocity.cache.local.enabled system property will always take precedence.

      Parameters:
      enabled - whether to enable the local build cache

    • isStoreEnabled

      boolean isStoreEnabled()
      Whether storing build cache entries is enabled.
      Returns:
      true if storing build cache entries is enabled, false otherwise

    • setStoreEnabled

      void setStoreEnabled(boolean storeEnabled)
      Sets whether to store build cache entries.

      Configuration via the develocity.cache.local.storeEnabled system property will always take precedence.

      Parameters:
      storeEnabled - whether to enable storing build cache entries

    • getDirectory

      File getDirectory()
      Gets the local build cache directory.
      Returns:
      the local build cache directory

    • setDirectory

      void setDirectory(File directory)
      Sets the local build cache directory.

      Configuration via the develocity.cache.local.directory system property will always take precedence.

      Parameters:
      directory - the local build cache directory

    • getCleanupPolicy

      CleanupPolicy getCleanupPolicy()
      Gets the cleanup policy configuration.
      Returns:
      the cleanup policy configuration