com.github.blindpirate.gogradle.core.cache

Class DefaultGlobalCacheManager

java.lang.Object

com.github.blindpirate.gogradle.core.cache.DefaultGlobalCacheManager

All Implemented Interfaces:

GlobalCacheManager

@Singleton
public class DefaultGlobalCacheManager
extends java.lang.Object
implements GlobalCacheManager

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GO_BINARAY_CACHE_PATH
static java.lang.String	GO_METADATA_PATH
static java.lang.String	GOPATH_CACHE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultGlobalCacheManager(GolangPluginSetting setting)

Method Summary

Modifier and Type	Method and Description
boolean	currentRepositoryIsUpToDate(NotationDependency dependency) Check if the repository corresponding to a dependency package has been updated recently in global cache.
void	ensureGlobalCacheExistAndWritable() Ensures global cache exists and is writable.
java.nio.file.Path	getGlobalGoBinCache(java.lang.String relativePath) Get the path which locates in relativePath relative to ~/.gradle/go/binary
java.nio.file.Path	getGlobalPackageCachePath(java.lang.String packagePath) Get the go repository in global cache corresponding to packagePath
java.util.Optional<GlobalCacheMetadata>	getMetadata(java.nio.file.Path packagePath) Get the metadata of a package specified by packagePath
<T> T	runWithGlobalCacheLock(GolangDependency dependency, java.util.concurrent.Callable<T> callable) Locks global cache directory of dependency, and call the callable
void	updateCurrentDependencyLock(GolangDependency dependency) Updates corresponding metadata (i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GOPATH_CACHE_PATH

public static final java.lang.String GOPATH_CACHE_PATH

See Also:

Constant Field Values

GO_BINARAY_CACHE_PATH

public static final java.lang.String GO_BINARAY_CACHE_PATH

See Also:

Constant Field Values

GO_METADATA_PATH

public static final java.lang.String GO_METADATA_PATH

See Also:

Constant Field Values

Constructor Detail

DefaultGlobalCacheManager

@Inject
public DefaultGlobalCacheManager(GolangPluginSetting setting)

Method Detail

ensureGlobalCacheExistAndWritable

public void ensureGlobalCacheExistAndWritable()

Description copied from interface: GlobalCacheManager

Ensures global cache exists and is writable.

Specified by:

ensureGlobalCacheExistAndWritable in interface GlobalCacheManager

getGlobalPackageCachePath

public java.nio.file.Path getGlobalPackageCachePath(java.lang.String packagePath)

Description copied from interface: GlobalCacheManager

Get the go repository in global cache corresponding to packagePath

Specified by:

getGlobalPackageCachePath in interface GlobalCacheManager

Parameters:

packagePath - import path of the package

Returns:

the location of that repository in global cache

getGlobalGoBinCache

public java.nio.file.Path getGlobalGoBinCache(java.lang.String relativePath)

Description copied from interface: GlobalCacheManager

Get the path which locates in relativePath relative to ~/.gradle/go/binary

Specified by:

getGlobalGoBinCache in interface GlobalCacheManager

Parameters:

relativePath - the relative path to ~/.gradle/go/binary

Returns:

the path

getMetadata

public java.util.Optional<GlobalCacheMetadata> getMetadata(java.nio.file.Path packagePath)

Description copied from interface: GlobalCacheManager

Get the metadata of a package specified by packagePath

Specified by:

getMetadata in interface GlobalCacheManager

Parameters:

packagePath - import path of the package

Returns:

the metadata if that package exists in global cache, Optional.empty() otherwise.

runWithGlobalCacheLock

public <T> T runWithGlobalCacheLock(GolangDependency dependency,
                                    java.util.concurrent.Callable<T> callable)
                             throws java.lang.Exception

Description copied from interface: GlobalCacheManager

Locks global cache directory of dependency, and call the callable

Specified by:

runWithGlobalCacheLock in interface GlobalCacheManager

Type Parameters:

T - return value type of callable

Parameters:

dependency - dependency to be locked

callable - code to be executed under lock

Returns:

the return value of callable

Throws:

java.lang.Exception - exception thrown by callable

currentRepositoryIsUpToDate

public boolean currentRepositoryIsUpToDate(NotationDependency dependency)

Description copied from interface: GlobalCacheManager

Check if the repository corresponding to a dependency package has been updated recently in global cache.

Specified by:

currentRepositoryIsUpToDate in interface GlobalCacheManager

Parameters:

dependency - the dependency package

Returns:

true if the package is up-to-date, false otherwise.

See Also:

GolangPluginSetting.getGlobalCacheSecond()

updateCurrentDependencyLock

public void updateCurrentDependencyLock(GolangDependency dependency)

Description copied from interface: GlobalCacheManager

Updates corresponding metadata (i.e. the lock) file of a dependency package.

Specified by:

updateCurrentDependencyLock in interface GlobalCacheManager

Parameters:

dependency - the dependency package