ProjectCacheImpl (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.project.ProjectCacheImpl

All Implemented Interfaces:

ProjectCache
```
public class ProjectCacheImpl
extends java.lang.Object
implements ProjectCache
```
Cache of project information, including access rights.

Method Summary

Methods
Modifier and Type	Method and Description
`java.util.SortedSet<com.google.gerrit.reviewdb.client.Project.NameKey>`	`all()`
`java.lang.Iterable<com.google.gerrit.reviewdb.client.Project.NameKey>`	`byName(java.lang.String pfx)` Filter the set of registered project names by common prefix.
`ProjectState`	`checkedGet(com.google.gerrit.reviewdb.client.Project.NameKey projectName)` Get the cached data for a project by its unique name.
`void`	`evict(com.google.gerrit.reviewdb.client.Project.NameKey p)` Invalidate the cached information about the given project.
`void`	`evict(com.google.gerrit.reviewdb.client.Project p)` Invalidate the cached information about the given project.
`ProjectState`	`get(com.google.gerrit.reviewdb.client.Project.NameKey projectName)` Get the cached data for a project by its unique name.
`ProjectState`	`getAllProjects()`
`ProjectState`	`getAllUsers()`
`java.util.Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID>`	`guessRelevantGroupUUIDs()`
`static com.google.inject.Module`	`module()`
`void`	`onCreateProject(com.google.gerrit.reviewdb.client.Project.NameKey newProjectName)` Notify the cache that a new project was constructed.
`void`	`remove(com.google.gerrit.reviewdb.client.Project.NameKey name)` Remove information about the given project from the cache.
`void`	`remove(com.google.gerrit.reviewdb.client.Project p)` Remove information about the given project from the cache.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - module
```
public static com.google.inject.Module module()
```
  - getAllProjects
```
public ProjectState getAllProjects()
```
    Specified by:
    
    getAllProjects in interface ProjectCache
    
    Returns:
    the parent state for all projects on this server.
  - getAllUsers
```
public ProjectState getAllUsers()
```
    Specified by:
    
    getAllUsers in interface ProjectCache
    
    Returns:
    the project state of the project storing meta data for all users.
  - get
```
public ProjectState get(com.google.gerrit.reviewdb.client.Project.NameKey projectName)
```
    Description copied from interface: ProjectCache
    
    Get the cached data for a project by its unique name.
    
    Specified by:
    
    get in interface ProjectCache
    
    Parameters:
    projectName - name of the project.
    
    Returns:
    the cached data; null if no such project exists or a error occurred.
    See Also:
    ProjectCache.checkedGet(com.google.gerrit.reviewdb.client.Project.NameKey)
  - checkedGet
```
public ProjectState checkedGet(com.google.gerrit.reviewdb.client.Project.NameKey projectName)
                        throws java.io.IOException
```
    Description copied from interface: ProjectCache
    
    Get the cached data for a project by its unique name.
    
    Specified by:
    
    checkedGet in interface ProjectCache
    
    Parameters:
    projectName - name of the project.
    
    Returns:
    the cached data; null if no such project exists.
    
    Throws:
    
    java.io.IOException - when there was an error.
  - evict
```
public void evict(com.google.gerrit.reviewdb.client.Project p)
```
    Description copied from interface: ProjectCache
    
    Invalidate the cached information about the given project.
    
    Specified by:
    
    evict in interface ProjectCache
  - evict
```
public void evict(com.google.gerrit.reviewdb.client.Project.NameKey p)
```
    Invalidate the cached information about the given project.
    
    Specified by:
    
    evict in interface ProjectCache
  - remove
```
public void remove(com.google.gerrit.reviewdb.client.Project p)
```
    Description copied from interface: ProjectCache
    
    Remove information about the given project from the cache. It will no longer be returned from ProjectCache.all().
    
    Specified by:
    
    remove in interface ProjectCache
  - remove
```
public void remove(com.google.gerrit.reviewdb.client.Project.NameKey name)
```
    Description copied from interface: ProjectCache
    
    Remove information about the given project from the cache. It will no longer be returned from ProjectCache.all().
    
    Specified by:
    
    remove in interface ProjectCache
  - onCreateProject
```
public void onCreateProject(com.google.gerrit.reviewdb.client.Project.NameKey newProjectName)
```
    Description copied from interface: ProjectCache
    
    Notify the cache that a new project was constructed.
    
    Specified by:
    
    onCreateProject in interface ProjectCache
  - all
```
public java.util.SortedSet<com.google.gerrit.reviewdb.client.Project.NameKey> all()
```
    Specified by:
    
    all in interface ProjectCache
    
    Returns:
    sorted iteration of projects.
  - guessRelevantGroupUUIDs
```
public java.util.Set<com.google.gerrit.reviewdb.client.AccountGroup.UUID> guessRelevantGroupUUIDs()
```
    Specified by:
    
    guessRelevantGroupUUIDs in interface ProjectCache
    
    Returns:
    estimated set of relevant groups extracted from hot project access rules. If the cache is cold or too small for the entire project set of the server, this set may be incomplete.
  - byName
```
public java.lang.Iterable<com.google.gerrit.reviewdb.client.Project.NameKey> byName(java.lang.String pfx)
```
    Description copied from interface: ProjectCache
    
    Filter the set of registered project names by common prefix.
    
    Specified by:
    
    byName in interface ProjectCache
    
    Parameters:
    pfx - common prefix.
    
    Returns:
    sorted iteration of projects sharing the same prefix.

Class ProjectCacheImpl

Method Summary

Methods inherited from class java.lang.Object

Method Detail

module

getAllProjects

getAllUsers

get

checkedGet

evict

evict

remove

remove

onCreateProject

all

guessRelevantGroupUUIDs

byName