Uses of Package
org.apache.lucene.util

Packages that use org.apache.lucene.util

Package	Description
org.apache.lucene.analysis	Text analysis.
org.apache.lucene.analysis.tokenattributes	General-purpose attributes for text analysis.
org.apache.lucene.codecs	Codecs API: API for customization of the encoding and structure of the index.
org.apache.lucene.codecs.blocktree	BlockTree terms dictionary.
org.apache.lucene.codecs.compressing	StoredFieldsFormat that allows cross-document and cross-field compression of stored fields.
org.apache.lucene.codecs.lucene50	Components from the Lucene 5.0 index format See org.apache.lucene.codecs.lucene53 for an overview of the index format.
org.apache.lucene.codecs.lucene54	Lucene 5.4 file format.
org.apache.lucene.codecs.perfield	Postings format that can delegate to different formats per-field.
org.apache.lucene.document	The logical representation of a Document for indexing and searching.
org.apache.lucene.index	Code to maintain and access indices.
org.apache.lucene.search	Code to search indices.
org.apache.lucene.search.similarities	This package contains the various ranking models that can be used in Lucene.
org.apache.lucene.store	Binary i/o API, used for all index data.
org.apache.lucene.util	Some utility classes.
org.apache.lucene.util.automaton	Finite-state automaton for regular expressions.
org.apache.lucene.util.fst	Finite state transducers
org.apache.lucene.util.mutable	Comparable object wrappers
org.apache.lucene.util.packed	Packed integer arrays and streams.

Classes in org.apache.lucene.util used by org.apache.lucene.analysis

Class and Description
Attribute Base interface for attributes.
AttributeFactory An AttributeFactory creates instances of AttributeImpls.
AttributeImpl Base class for Attributes that can be added to a AttributeSource.
AttributeReflector This interface is used to reflect contents of AttributeSource or AttributeImpl.
AttributeSource An AttributeSource contains a list of different AttributeImpls, and methods to add and get them.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
Version Use by certain classes to match version compatibility across releases of Lucene.

Classes in org.apache.lucene.util used by org.apache.lucene.analysis.tokenattributes

Class and Description
Attribute Base interface for attributes.
AttributeImpl Base class for Attributes that can be added to a AttributeSource.
AttributeReflector This interface is used to reflect contents of AttributeSource or AttributeImpl.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRefBuilder A builder for BytesRef instances.

Classes in org.apache.lucene.util used by org.apache.lucene.codecs

Class and Description
Accountable An object whose RAM usage can be computed.
Bits Interface for Bitset-like structures.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
FixedBitSet BitSet of fixed length (numBits), backed by accessible (FixedBitSet.getBits()) long[], accessed with an int index, implementing Bits and DocIdSet.
MutableBits Extension of Bits for live documents.
NamedSPILoader.NamedSPI Interface to support NamedSPILoader.lookup(String) by name.

Classes in org.apache.lucene.util used by org.apache.lucene.codecs.blocktree

Class and Description
Accountable An object whose RAM usage can be computed.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].

Classes in org.apache.lucene.util used by org.apache.lucene.codecs.compressing

Class and Description
Accountable An object whose RAM usage can be computed.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].

Classes in org.apache.lucene.util used by org.apache.lucene.codecs.lucene50

Class and Description
Accountable An object whose RAM usage can be computed.
Bits Interface for Bitset-like structures.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
MutableBits Extension of Bits for live documents.
NamedSPILoader.NamedSPI Interface to support NamedSPILoader.lookup(String) by name.

Classes in org.apache.lucene.util used by org.apache.lucene.codecs.lucene54

Class and Description
NamedSPILoader.NamedSPI Interface to support NamedSPILoader.lookup(String) by name.

Classes in org.apache.lucene.util used by org.apache.lucene.codecs.perfield

Class and Description
NamedSPILoader.NamedSPI Interface to support NamedSPILoader.lookup(String) by name.

Classes in org.apache.lucene.util used by org.apache.lucene.document

Class and Description
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].

Classes in org.apache.lucene.util used by org.apache.lucene.index

Class and Description
Accountable An object whose RAM usage can be computed.
AttributeSource An AttributeSource contains a list of different AttributeImpls, and methods to add and get them.
Bits Interface for Bitset-like structures.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRefBuilder A builder for BytesRef instances.
BytesRefIterator A simple iterator interface for BytesRef iteration.
InfoStream Debugging API for Lucene classes such as IndexWriter and SegmentInfos.
LongValues Abstraction over an array of longs.
MutableBits Extension of Bits for live documents.
Version Use by certain classes to match version compatibility across releases of Lucene.

Classes in org.apache.lucene.util used by org.apache.lucene.search

Class and Description
Accountable An object whose RAM usage can be computed.
Attribute Base interface for attributes.
AttributeImpl Base class for Attributes that can be added to a AttributeSource.
AttributeReflector This interface is used to reflect contents of AttributeSource or AttributeImpl.
AttributeSource An AttributeSource contains a list of different AttributeImpls, and methods to add and get them.
Bits Interface for Bitset-like structures.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRefIterator A simple iterator interface for BytesRef iteration.
Counter Simple counter class
PriorityQueue A PriorityQueue maintains a partial ordering of its elements such that the least element can always be found in constant time.

Classes in org.apache.lucene.util used by org.apache.lucene.search.similarities

Class and Description
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].

Classes in org.apache.lucene.util used by org.apache.lucene.store

Class and Description
Accountable An object whose RAM usage can be computed.
SuppressForbidden Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.

Classes in org.apache.lucene.util used by org.apache.lucene.util

Class and Description
Accountable An object whose RAM usage can be computed.
Attribute Base interface for attributes.
AttributeFactory An AttributeFactory creates instances of AttributeImpls.
AttributeImpl Base class for Attributes that can be added to a AttributeSource.
AttributeReflector This interface is used to reflect contents of AttributeSource or AttributeImpl.
AttributeSource An AttributeSource contains a list of different AttributeImpls, and methods to add and get them.
AttributeSource.State This class holds the state of an AttributeSource.
BitDocIdSet Implementation of the DocIdSet interface on top of a BitSet.
Bits Interface for Bitset-like structures.
BitSet Base implementation for a bit set.
ByteBlockPool Class that Posting and PostingVector use to write byte streams into shared fixed-size byte[] arrays.
ByteBlockPool.Allocator Abstract class for allocating and freeing byte blocks.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRefBuilder A builder for BytesRef instances.
BytesRefHash.BytesStartArray Manages allocation of the per-term addresses.
BytesRefIterator A simple iterator interface for BytesRef iteration.
CharsRef Represents char[], as a slice (offset + length) into an existing char[].
CharsRefBuilder A builder for CharsRef instances.
Counter Simple counter class
FixedBitSet BitSet of fixed length (numBits), backed by accessible (FixedBitSet.getBits()) long[], accessed with an int index, implementing Bits and DocIdSet.
InfoStream Debugging API for Lucene classes such as IndexWriter and SegmentInfos.
IntBlockPool A pool for int blocks similar to ByteBlockPool
IntBlockPool.Allocator Abstract class for allocating and freeing int blocks.
IntsRef Represents int[], as a slice (offset + length) into an existing int[].
LongBitSet BitSet of fixed length (numBits), backed by accessible (LongBitSet.getBits()) long[], accessed with a long index.
LongsRef Represents long[], as a slice (offset + length) into an existing long[].
LongValues Abstraction over an array of longs.
MutableBits Extension of Bits for live documents.
NamedSPILoader.NamedSPI Interface to support NamedSPILoader.lookup(String) by name.
NumericUtils.IntRangeBuilder Callback for NumericUtils.splitIntRange(org.apache.lucene.util.NumericUtils.IntRangeBuilder, int, int, int).
NumericUtils.LongRangeBuilder Callback for NumericUtils.splitLongRange(org.apache.lucene.util.NumericUtils.LongRangeBuilder, int, long, long).
OfflineSorter.BufferSize A bit more descriptive unit for constructors.
OfflineSorter.SortInfo Sort info (debugging mostly).
PagedBytes.PagedBytesDataInput
PagedBytes.PagedBytesDataOutput
PagedBytes.Reader Provides methods to read BytesRefs from a frozen PagedBytes.
RoaringDocIdSet DocIdSet implementation inspired from http://roaringbitmap.org/ The space is divided into blocks of 2^16 bits and each block is encoded independently.
RoaringDocIdSet.Builder A builder of RoaringDocIdSets.
RollingBuffer.Resettable Implement to reset an instance
Sorter Base class for sorting algorithms implementations.
SparseFixedBitSet A bit set that only stores longs that have at least one bit which is set.
SPIClassIterator Helper class for loading SPI classes from classpath (META-INF files).
SuppressForbidden Annotation to suppress forbidden-apis errors inside a whole class, a method, or a field.
Version Use by certain classes to match version compatibility across releases of Lucene.
VirtualMethod A utility for keeping backwards compatibility on previously abstract methods (or similar replacements).
WeakIdentityMap Implements a combination of WeakHashMap and IdentityHashMap.

Classes in org.apache.lucene.util used by org.apache.lucene.util.automaton

Class and Description
Accountable An object whose RAM usage can be computed.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRefBuilder A builder for BytesRef instances.
IntsRef Represents int[], as a slice (offset + length) into an existing int[].

Classes in org.apache.lucene.util used by org.apache.lucene.util.fst

Class and Description
Accountable An object whose RAM usage can be computed.
BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
BytesRefBuilder A builder for BytesRef instances.
CharsRef Represents char[], as a slice (offset + length) into an existing char[].
IntsRef Represents int[], as a slice (offset + length) into an existing int[].
IntsRefBuilder A builder for IntsRef instances.

Classes in org.apache.lucene.util used by org.apache.lucene.util.mutable

Class and Description
BytesRefBuilder A builder for BytesRef instances.

Classes in org.apache.lucene.util used by org.apache.lucene.util.packed

Class and Description
Accountable An object whose RAM usage can be computed.
LongsRef Represents long[], as a slice (offset + length) into an existing long[].
LongValues Abstraction over an array of longs.