com.google.cloud.tools.jib.cache

Class Cache

java.lang.Object

com.google.cloud.tools.jib.cache.Cache

All Implemented Interfaces:

Closeable, AutoCloseable

public class Cache
extends Object
implements Closeable

Manages a cache. Implementation is thread-safe.

Method Summary

Modifier and Type	Method and Description
void	addCachedLayersToMetadata(List<CachedLayer> cachedLayers) Adds the cached layer to the cache metadata.
void	addCachedLayersWithMetadataToMetadata(List<CachedLayerWithMetadata> cachedLayersWithMetadata) Adds the cached layer to the cache metadata.
void	close() Finishes the use of the cache by flushing any unsaved changes.
static Cache	init(Path cacheDirectory) Initializes a cache with a directory.

Methods inherited from class java.lang.Object

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

Method Detail

init

public static Cache init(Path cacheDirectory)
                  throws NotDirectoryException,
                         CacheMetadataCorruptedException

Initializes a cache with a directory. This also loads the cache metadata if it exists in the directory.

Parameters:

cacheDirectory - the directory to use for the cache.

Returns:

the initialized cache.

Throws:

NotDirectoryException - if cacheDirectory is not a directory.

CacheMetadataCorruptedException - if loading the cache metadata fails.

close

public void close()
           throws IOException

Finishes the use of the cache by flushing any unsaved changes.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - if saving the cache metadata fails.

addCachedLayersToMetadata

public void addCachedLayersToMetadata(List<CachedLayer> cachedLayers)

Adds the cached layer to the cache metadata. This is NOT thread-safe.

Parameters:

cachedLayers - the layers to add

addCachedLayersWithMetadataToMetadata

public void addCachedLayersWithMetadataToMetadata(List<CachedLayerWithMetadata> cachedLayersWithMetadata)

Adds the cached layer to the cache metadata. This is NOT thread-safe.

Parameters:

cachedLayersWithMetadata - the layers to add