org.apache.maven.project.artifact

Interface ProjectArtifactsCache

All Known Implementing Classes:

DefaultProjectArtifactsCache

public interface ProjectArtifactsCache

Caches project artifacts. Warning: This is an internal utility interface that is only public for technical reasons, it is not part of the public API. In particular, this interface can be changed or deleted without prior notice.

Author:

Igor Fedorenko, Benjamin Bentmann, Anton Tanasenko

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProjectArtifactsCache.CacheRecord CacheRecord
static interface	ProjectArtifactsCache.Key A cache key.

Method Summary

Modifier and Type	Method and Description
ProjectArtifactsCache.Key	createKey(MavenProject project, Collection<String> scopesToCollect, Collection<String> scopesToResolve, boolean aggregating, RepositorySystemSession session)
void	flush()
ProjectArtifactsCache.CacheRecord	get(ProjectArtifactsCache.Key key)
ProjectArtifactsCache.CacheRecord	put(ProjectArtifactsCache.Key key, LifecycleExecutionException e)
ProjectArtifactsCache.CacheRecord	put(ProjectArtifactsCache.Key key, Set<Artifact> pluginArtifacts)
void	register(MavenProject project, ProjectArtifactsCache.Key cacheKey, ProjectArtifactsCache.CacheRecord record) Registers the specified cache record for usage with the given project.

Method Detail

createKey

ProjectArtifactsCache.Key createKey(MavenProject project,
                                    Collection<String> scopesToCollect,
                                    Collection<String> scopesToResolve,
                                    boolean aggregating,
                                    RepositorySystemSession session)

get

ProjectArtifactsCache.CacheRecord get(ProjectArtifactsCache.Key key)
                               throws LifecycleExecutionException

Throws:

LifecycleExecutionException

put

ProjectArtifactsCache.CacheRecord put(ProjectArtifactsCache.Key key,
                                      Set<Artifact> pluginArtifacts)

put

ProjectArtifactsCache.CacheRecord put(ProjectArtifactsCache.Key key,
                                      LifecycleExecutionException e)

flush

void flush()

register

void register(MavenProject project,
              ProjectArtifactsCache.Key cacheKey,
              ProjectArtifactsCache.CacheRecord record)

Registers the specified cache record for usage with the given project. Integrators can use the information collected from this method in combination with a custom cache implementation to dispose unused records from the cache.

Parameters:

project - The project that employs the plugin realm, must not be null.

record - The cache record being used for the project, must not be null.