IndexReader.CacheHelper

All Known Implementing Classes:: SoftDeletesDirectoryReaderWrapper.DelegatingCacheHelper

Enclosing class:: IndexReader

public static interface IndexReader.CacheHelper

A utility class that gives hooks in order to help build a cache based on the data that is contained in this index.

Method Summary

Modifier and Type

Method

Description

void

addClosedListener(IndexReader.ClosedListener listener)

Add a IndexReader.ClosedListener which will be called when the resource guarded by getKey() is closed.

IndexReader.CacheKey

getKey()

Get a key that the resource can be cached on.

Method Details
- getKey
  
  IndexReader.CacheKey getKey()
  
  Get a key that the resource can be cached on. The given entry can be compared using identity, ie. Object.equals(java.lang.Object) is implemented as == and Object.hashCode() is implemented as System.identityHashCode(java.lang.Object).
- addClosedListener
  
  void addClosedListener(IndexReader.ClosedListener listener)
  
  Add a IndexReader.ClosedListener which will be called when the resource guarded by getKey() is closed.