org.apache.maven.project

Interface ProjectRealmCache

All Known Implementing Classes:

DefaultProjectRealmCache

public interface ProjectRealmCache

Caches project class realms. 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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
ProjectRealmCache.Key	createKey(List<? extends org.codehaus.plexus.classworlds.realm.ClassRealm> extensionRealms)
void	flush()
ProjectRealmCache.CacheRecord	get(ProjectRealmCache.Key key)
ProjectRealmCache.CacheRecord	put(ProjectRealmCache.Key key, org.codehaus.plexus.classworlds.realm.ClassRealm projectRealm, DependencyFilter extensionArtifactFilter)
void	register(MavenProject project, ProjectRealmCache.Key key, ProjectRealmCache.CacheRecord record) Registers the specified cache record for usage with the given project.

Method Detail

createKey

ProjectRealmCache.Key createKey(List<? extends org.codehaus.plexus.classworlds.realm.ClassRealm> extensionRealms)

get

ProjectRealmCache.CacheRecord get(ProjectRealmCache.Key key)

put

ProjectRealmCache.CacheRecord put(ProjectRealmCache.Key key,
                                  org.codehaus.plexus.classworlds.realm.ClassRealm projectRealm,
                                  DependencyFilter extensionArtifactFilter)

flush

void flush()

register

void register(MavenProject project,
              ProjectRealmCache.Key key,
              ProjectRealmCache.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.