# 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.standard | Fast, general-purpose grammar-based tokenizer `StandardTokenizer` implements the Word Break rules from the Unicode Text Segmentation algorithm, as specified in Unicode Standard Annex #29.
  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.lucene80` for an overview of the index format.
  org.apache.lucene.codecs.lucene60 | Components from the Lucene 6.0 index format.
  org.apache.lucene.codecs.lucene80 | Components from the Lucene 8.0 index format See `org.apache.lucene.codecs.lucene84` for an overview of the index format.
  org.apache.lucene.codecs.lucene84 | Lucene 8.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.bkd | Block KD-tree, implementing the generic spatial data structure described in this paper.
  org.apache.lucene.util.fst | Finite state transducers
  org.apache.lucene.util.graph | Utility classes for working with token streams as graphs.
  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
  AttributeFactory An AttributeFactory creates instances of `AttributeImpl`s.
  AttributeSource An AttributeSource contains a list of different `AttributeImpl`s, 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.standard
  Class and Description
  AttributeFactory An AttributeFactory creates instances of `AttributeImpl`s.
  AttributeSource An AttributeSource contains a list of different `AttributeImpl`s, and methods to add and get them.

- 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`.
  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
  Bits Interface for Bitset-like structures.

- Classes in org.apache.lucene.util used by org.apache.lucene.codecs.lucene60
  Class and Description
  Accountable An object whose RAM usage can be computed.

- Classes in org.apache.lucene.util used by org.apache.lucene.codecs.lucene80
  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.lucene84
  Class and Description
  Accountable An object whose RAM usage can be computed.
  BytesRef Represents byte[], as a slice (offset + length) into an existing byte[].
  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 `AttributeImpl`s, 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.
  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`.
  IOSupplier This is a result supplier that is allowed to throw an IOException.
  LongValues Abstraction over an array of longs.
  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.

- 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 `AttributeImpl`s, 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
  IOSupplier This is a result supplier that is allowed to throw an IOException.
  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 `AttributeImpl`s.
  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 `AttributeImpl`s, and methods to add and get them.
  AttributeSource.State This class holds the state of an AttributeSource.
  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[].
  BytesRefArray.IndexedBytesRefIterator An extension of `BytesRefIterator` that allows retrieving the index of the current element
  BytesRefArray.SortState Used to iterate the elements of an array in a given order.
  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
  DocIdSetBuilder.BulkAdder Utility class to efficiently add many docs in one go.
  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[].
  IOUtils.IOConsumer An IO operation with a single input.
  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.
  NamedSPILoader.NamedSPI Interface to support `NamedSPILoader.lookup(String)` by name.
  OfflineSorter.BufferSize A bit more descriptive unit for constructors.
  OfflineSorter.ByteSequencesReader Utility class to read length-prefixed byte[] entries from an input.
  OfflineSorter.ByteSequencesWriter Utility class to emit length-prefixed byte[] entries to an output stream for sorting.
  PagedBytes.PagedBytesDataInput
  PagedBytes.PagedBytesDataOutput
  PagedBytes.Reader Provides methods to read BytesRefs from a frozen PagedBytes.
  QueryBuilder.TermAndBoost Wraps a term and boost
  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 `RoaringDocIdSet`s.
  RollingBuffer.Resettable Implement to reset an instance
  Selector An implementation of a selection algorithm, ie.
  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.
  CharsRef Represents char[], as a slice (offset + length) into an existing char[].
  IntsRef Represents int[], as a slice (offset + length) into an existing int[].

- Classes in org.apache.lucene.util used by org.apache.lucene.util.bkd
  Class and Description
  Accountable An object whose RAM usage can be computed.
  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`.

- 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.
  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.graph
  Class and Description
  AttributeSource An AttributeSource contains a list of different `AttributeImpl`s, and methods to add and get them.

- 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.

Copyright © 2000-2020 Apache Software Foundation. All Rights Reserved.