Interface PluginCacheManagement


  • public interface PluginCacheManagement
    Methods for working with the plugin cache.
    Since:
    2.1
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.gradle.api.provider.Provider<java.io.File> getPluginDir()
      Cache directory for plugins / providers.
      org.gradle.api.provider.Provider<java.lang.Integer> getPluginDirTimeout()
      Local timeout for the cache directory for plugins / providers.
      void useConfiguredPluginCache()
      Use the plugin cache directory configured in the global configuration of the root project.
      void useCustomPluginCache()
      Use a custom plugin cache directory for this source set.
      void useCustomPluginCache​(java.lang.Object dir, java.lang.Integer timeout)
      Use a custom plugin cache by specifying both a directory and a lock timeout.
    • Method Detail

      • getPluginDir

        org.gradle.api.provider.Provider<java.io.File> getPluginDir()
        Cache directory for plugins / providers.
        Returns:
        Location of plugin directory.
      • getPluginDirTimeout

        org.gradle.api.provider.Provider<java.lang.Integer> getPluginDirTimeout()
        Local timeout for the cache directory for plugins / providers.
        Returns:
        Timeout in milliseconds. If less than 1, then no lock will be performed
      • useConfiguredPluginCache

        void useConfiguredPluginCache()
        Use the plugin cache directory configured in the global configuration of the root project.
      • useCustomPluginCache

        void useCustomPluginCache()
        Use a custom plugin cache directory for this source set.

        The plugin dir will be place underneath the project cache directory and is guaranteed to have a unique name with the context of the whole project hierarchy.

      • useCustomPluginCache

        void useCustomPluginCache​(java.lang.Object dir,
                                  java.lang.Integer timeout)
        Use a custom plugin cache by specifying both a directory and a lock timeout.
        Parameters:
        dir - Directory where the cache should be located. Anything convertible to a file.
        timeout - Lock timeout in milliseconds. If this directory to the source set, pass zero to avoid locking mechanisms. However, if this directory is still shared, provide a timeout for safety purposes.