Provides methods for sanity checking that entries in the FieldCache
are not wasteful or inconsistent.
Lucene 2.9 Introduced numerous enhancements into how the FieldCache
is used by the low levels of Lucene searching (for Sorting and
ValueSourceQueries) to improve both the speed for Sorting, as well
as reopening of IndexReaders. But these changes have shifted the
usage of FieldCache from "top level" IndexReaders (frequently a
MultiReader or DirectoryReader) down to the leaf level SegmentReaders.
As a result, existing applications that directly access the FieldCache
may find RAM usage increase significantly when upgrading to 2.9 or
Later. This class provides an API for these applications (or their
Unit tests) to check at run time if the FieldCache contains "insane"
usages of the FieldCache.
EXPERIMENTAL API: This API is considered extremely advanced and
experimental. It may be removed or altered w/o warning in future releases
of Lucene.
The FieldCacheSanityChecker..::..Insanity type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | FieldCacheSanityChecker..::..Insanity | Initializes a new instance of the FieldCacheSanityChecker..::..Insanity class |
Methods
| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetCacheEntries | CacheEntry objects which suggest a problem |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetMsg | Description of hte insane behavior |
| GetType | Type of insane behavior this object represents |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | Multi-Line representation of this Insanity object, starting with
the Type and Msg, followed by each CacheEntry.toString() on it's
own line prefaced by a tab character
(Overrides Object..::..ToString()()()().) |
