Package org.apache.lucene.util

Interface Accountable

All Known Subinterfaces:

FSTStore, IndexDictionary, IndexDictionary.BrowserSupplier

All Known Implementing Classes:

AbstractPagedMutable, AnalyzingInfixSuggester, AnalyzingSuggester, Automaton, AutomatonQuery, BinaryDocValuesFieldUpdates, BitDocIdSet, BitSet, BlendedInfixSuggester, BlockHeader, BlockLine, BlockLine.Serializer, BlockPackedReader, BlockReader, BlockTermsReader, BlockTermsReader.FieldReader, BlockTreeTermsReader, BloomFilteringPostingsFormat.BloomFilteredFieldsProducer, BM25FQuery, BufferedUpdates, BufferedUpdatesStream, ByteBlockPool, ByteBuffersDataInput, ByteBuffersDataOutput, ByteRunAutomaton, BytesRefArray.SortState, BytesRefHash, BytesStore, CharacterRunAutomaton, CodecReader, CompiledAutomaton, CompletionFieldsProducer, CompletionsTermsReader, CompressingStoredFieldsReader, CompressingStoredFieldsWriter, CompressingTermVectorsReader, CompressingTermVectorsWriter, ContextQuery, CoveringQuery, DefaultIndexingChain, DeltaBaseTermStateSerializer, DeltaPackedLongValues, DeltaPackedLongValues.Builder, Direct16, Direct32, Direct64, Direct8, DirectDocValuesProducer, DirectDocValuesProducer.BinaryRawValues, DirectDocValuesProducer.NumericRawValues, DirectDocValuesProducer.SortedNumericRawValues, DirectDocValuesProducer.SortedRawValues, DirectDocValuesProducer.SortedSetRawValues, DirectMonotonicReader, DirectMonotonicReader.Meta, DirectPacked64SingleBlockReader, DirectPackedReader, DirectPostingsFormat.DirectField, DirectPostingsFormat.DirectField.HighFreqTerm, DirectPostingsFormat.DirectField.LowFreqTerm, DirectPostingsFormat.DirectField.TermAndSkip, DirectPostingsFormat.DirectFields, DocConsumer, DocIdSet, DocsWithFieldSet, DocumentsWriter, DocumentsWriterDeleteQueue, DocumentsWriterFlushControl, DocumentsWriterPerThread, DocValuesFieldUpdates, DocValuesFieldUpdates.SingleValueDocValuesFieldUpdates, DocValuesNumbersQuery, DocValuesProducer, DocValuesTermsQuery, EmptyDocValuesProducer, FieldMetadata, FieldReader, FieldsIndex, FieldsIndexReader, FieldsProducer, FilterCodecReader, FixedBitSet, FixedGapTermsIndexReader, FixedGapTermsIndexReader.FieldIndexData, FreeTextSuggester, FrequencyTrackingRingBuffer, FrequencyTrackingRingBuffer.IntBag, FST, FSTCompletionLookup, FSTDictionary, FSTDictionary.BrowserSupplier, FSTTermOutputs.TermData, FSTTermsReader, FSTTermsReader.TermsReader, FuzzySet, FuzzySuggester, GlobalOrdinalsQuery, GlobalOrdinalsWithScoreQuery, GrowableByteArrayDataOutput, GrowableWriter, IDVersionPostingsReader, IndexWriter, IntArrayDocIdSet, IntersectBlockReader, JaspellLookup, JaspellTernarySearchTrie, JaspellTernarySearchTrie.TSTNode, LegacyFieldsIndexReader, LongBitSet, LongHashSet, Lookup, LRUQueryCache, LRUQueryCache.LeafCache, Lucene50PostingsReader, Lucene60PointsReader, Lucene70DocValuesProducer, Lucene70NormsProducer, Lucene80DocValuesProducer, Lucene80NormsProducer, Lucene84PostingsReader, Lucene86PointsReader, MonotonicBlockPackedReader, MonotonicLongValues, MonotonicLongValues.Builder, MultiPassIndexSplitter.FakeDeleteLeafIndexReader, NormsProducer, NotDocIdSet, NRTCachingDirectory, NRTSuggester, NumericDocValuesFieldUpdates, NumericDocValuesFieldUpdates.SingleValueNumericDocValuesFieldUpdates, OffHeapFSTStore, OnHeapFSTStore, OrdinalMap, OrdinalMap.SegmentMap, OrdsBlockTreeTermsReader, OrdsFieldReader, Packed16ThreeBlocks, Packed64, Packed64SingleBlock, Packed64SingleBlock.Packed64SingleBlock1, Packed64SingleBlock.Packed64SingleBlock10, Packed64SingleBlock.Packed64SingleBlock12, Packed64SingleBlock.Packed64SingleBlock16, Packed64SingleBlock.Packed64SingleBlock2, Packed64SingleBlock.Packed64SingleBlock21, Packed64SingleBlock.Packed64SingleBlock3, Packed64SingleBlock.Packed64SingleBlock32, Packed64SingleBlock.Packed64SingleBlock4, Packed64SingleBlock.Packed64SingleBlock5, Packed64SingleBlock.Packed64SingleBlock6, Packed64SingleBlock.Packed64SingleBlock7, Packed64SingleBlock.Packed64SingleBlock8, Packed64SingleBlock.Packed64SingleBlock9, Packed8ThreeBlocks, PackedInts.Mutable, PackedInts.MutableImpl, PackedInts.NullReader, PackedInts.Reader, PackedInts.ReaderImpl, PackedLongValues, PackedLongValues.Builder, PagedBytes, PagedBytes.Reader, PagedGrowableWriter, PagedMutable, PerFieldDocValuesFormat.FieldsReader, PerFieldMergeState.FilterFieldsProducer, PerFieldPostingsFormat.FieldsReader, PKIndexSplitter.DocumentFilteredLeafIndexReader, PointInSetIncludingScoreQuery, PointInSetQuery, PointsReader, PostingsReaderBase, PrefixCodedTerms, PrefixQuery, RAMDirectory, RAMFile, RAMOutputStream, RegexpQuery, RoaringDocIdSet, RoaringDocIdSet.ShortArrayDocIdSet, RunAutomaton, SegmentDocValuesProducer, SegmentReader, SimpleTextBKDReader, SimpleTextDocValuesReader, SimpleTextFieldsReader, SimpleTextFieldsReader.SimpleTextTerms, SimpleTextNormsFormat.SimpleTextNormsProducer, SimpleTextPointsReader, SimpleTextStoredFieldsReader, SimpleTextStoredFieldsWriter, SimpleTextTermVectorsReader, SimpleTextTermVectorsWriter, SoftDeletesDirectoryReaderWrapper.SoftDeletesFilterCodecReader, SortingCodecReader, SparseFixedBitSet, STBlockLine, STBlockLine.Serializer, STBlockReader, STIntersectBlockReader, STMergingBlockReader, StoredFieldsReader, StoredFieldsWriter, STUniformSplitTerms, STUniformSplitTermsReader, Term, TermAutomatonQuery, TermAutomatonScorer.TermRunAutomaton, TermBytes, TermInSetQuery, TermRangeQuery, TermsIncludingScoreQuery, TermsIndexReaderBase, TermsQuery, TermVectorsReader, TermVectorsWriter, TSTLookup, UniformSplitTerms, UniformSplitTermsReader, VariableGapTermsIndexReader, VariableGapTermsIndexReader.FieldIndexData, VersionBlockTreeTermsReader, VersionFieldReader, WFSTCompletionLookup, WildcardQuery

public interface Accountable

An object whose RAM usage can be computed.

Field Summary

Fields

Modifier and Type	Field	Description
static Accountable	NULL_ACCOUNTABLE	An accountable that always returns 0

Method Summary

Modifier and Type	Method	Description
default java.util.Collection<Accountable>	getChildResources()	Returns nested resources of this class.
long	ramBytesUsed()	Return the memory usage of this object in bytes.

Field Detail

NULL_ACCOUNTABLE

static final Accountable NULL_ACCOUNTABLE

An accountable that always returns 0

Method Detail

ramBytesUsed

long ramBytesUsed()

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

default java.util.Collection<Accountable> getChildResources()

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

Accountables