Package org.opengrok.indexer.history

Class FileAnnotationCache

java.lang.Object
org.opengrok.indexer.history.AbstractCache
org.opengrok.indexer.history.FileAnnotationCache
All Implemented Interfaces:
AnnotationCache, Cache
public class FileAnnotationCache extends AbstractCache implements AnnotationCache

  • Constructor Details

    • FileAnnotationCache

      public FileAnnotationCache()

  • Method Details

    • initialize

      public void initialize()
      Description copied from interface: Cache
      Create and initialize an empty cache if one doesn't exist already.
      Specified by:
      initialize in interface Cache

    • getCacheFileSuffix

      public String getCacheFileSuffix()
      Specified by:
      getCacheFileSuffix in interface Cache
      Overrides:
      getCacheFileSuffix in class AbstractCache
      Returns:
      suffix used for the cache files

    • isUpToDate

      public boolean isUpToDate(File file)
      This is potentially expensive operation as the cache entry has to be retrieved from disk in order to tell whether it is stale or not.
      Specified by:
      isUpToDate in interface Cache
      Parameters:
      file - source file
      Returns:
      indication whether the cache entry is fresh

    • get

      public Annotation get(File file, @Nullable @Nullable String rev) throws CacheException
      Description copied from interface: AnnotationCache
      Retrieve annotation from cache.
      Specified by:
      get in interface AnnotationCache
      Parameters:
      file - file under source root to get the annotation for
      rev - requested revision
      Returns:
      Annotation object or null
      Throws:
      CacheException - on error

    • store

      public void store(File file, Annotation annotation) throws CacheException
      Description copied from interface: AnnotationCache
      Store annotation for file into cache.
      Specified by:
      store in interface AnnotationCache
      Parameters:
      file - file under source root to store the annotation for
      annotation - Annotation object
      Throws:
      CacheException - on error

    • clear

      public void clear(RepositoryInfo repository)
      Description copied from interface: Cache
      Clear the cache for a repository.
      Specified by:
      clear in interface Cache
      Parameters:
      repository - the repository whose cache to clear

    • optimize

      public void optimize()
      Description copied from interface: Cache
      Optimize how the history is stored on disk. This method is typically called after the cache has been populated, or after large modifications to the cache. The exact effect of this method is specific to each implementation, but it may for example include compressing, compacting or reordering the disk image of the cache in order to optimize performance or space usage.
      Specified by:
      optimize in interface Cache

    • supportsRepository

      public boolean supportsRepository(Repository repository)
      Description copied from interface: Cache
      Check whether this cache implementation can store history for the given repository.
      Specified by:
      supportsRepository in interface Cache
      Parameters:
      repository - the repository to check
      Returns:
      true if this cache implementation can store history for the repository, or false otherwise

    • getCacheDirName

      public String getCacheDirName()
      Specified by:
      getCacheDirName in interface Cache
      Returns:
      directory name to be used to store cache files under data root

    • getInfo

      public String getInfo()
      Description copied from interface: Cache
      Get a string with information about the cache.
      Specified by:
      getInfo in interface Cache
      Returns:
      a free form text string describing the history instance