com.google.cloud.tools.jib.configuration

Class CacheConfiguration

java.lang.Object

com.google.cloud.tools.jib.configuration.CacheConfiguration

public class CacheConfiguration
extends Object

Represents the location of the cache. Provides static methods for resolving a location for the cache.

Method Summary

Modifier and Type	Method and Description
static CacheConfiguration	forDefaultUserLevelCacheDirectory() The cache is at the default user-level cache directory.
static CacheConfiguration	forPath(Path cacheDirectory) The cache is at an arbitrary path.
Path	getCacheDirectory() Gets the path to the cache directory.
static CacheConfiguration	makeTemporary() The cache is a temporary directory that is deleted afterwards.
boolean	shouldEnsureOwnership() Gets whether or not the cache directory should be checked for write safety.

Methods inherited from class java.lang.Object

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

Method Detail

forPath

public static CacheConfiguration forPath(Path cacheDirectory)

The cache is at an arbitrary path.

Parameters:

cacheDirectory - the path to the cache directory. This must be a non-existent directory or a previously-used cache directory.

Returns:

the corresponding CacheConfiguration

makeTemporary

public static CacheConfiguration makeTemporary()
                                        throws CacheDirectoryCreationException

The cache is a temporary directory that is deleted afterwards.

Returns:

the corresponding CacheConfiguration

Throws:

CacheDirectoryCreationException - if a temporary directory cannot be created

forDefaultUserLevelCacheDirectory

public static CacheConfiguration forDefaultUserLevelCacheDirectory()

The cache is at the default user-level cache directory. This is usually to store base image layers, which can be shared between projects. The default user-level cache directory is [user cache home]/google-cloud-tools-java/jib.

Returns:

the corresponding CacheConfiguration

getCacheDirectory

public Path getCacheDirectory()

Gets the path to the cache directory.

Returns:

the cache directory path

shouldEnsureOwnership

public boolean shouldEnsureOwnership()

Gets whether or not the cache directory should be checked for write safety.

Returns:

true if ownership by Jib should be checked