org.apache.lucene.util.packed

## Class BlockPackedReaderIterator

- java.lang.Object
- - org.apache.lucene.util.packed.BlockPackedReaderIterator

-     public final class BlockPackedReaderIterator
      extends Object

  Reader for sequences of longs written with `BlockPackedWriter`.
  See Also:
    `BlockPackedWriter`
  NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `BlockPackedReaderIterator(DataInput in, int packedIntsVersion, int blockSize, long valueCount)` Sole constructor.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `long` | `next()` Read the next value.
    `LongsRef` | `next(int count)` Read between `1` and `count` values.
    `long` | `ord()` Return the offset of the next value to read.
    `void` | `reset(DataInput in, long valueCount)` Reset the current reader to wrap a stream of `valueCount` values contained in `in`.
    `void` | `skip(long count)` Skip exactly `count` values.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### BlockPackedReaderIterator

          public BlockPackedReaderIterator(DataInput in,
                                           int packedIntsVersion,
                                           int blockSize,
                                           long valueCount)

      Sole constructor.
      Parameters:
        `blockSize` - the number of values of a block, must be equal to the block size of the `BlockPackedWriter` which has been used to write the stream

  - ### Method Detail

    - #### reset

          public void reset(DataInput in,
                            long valueCount)

      Reset the current reader to wrap a stream of `valueCount` values contained in `in`. The block size remains unchanged.

    - #### skip

          public void skip(long count)
                    throws IOException

      Skip exactly `count` values.
      Throws:
        `IOException`

    - #### next

          public long next()
                    throws IOException

      Read the next value.
      Throws:
        `IOException`

    - #### next

          public LongsRef next(int count)
                        throws IOException

      Read between `1` and `count` values.
      Throws:
        `IOException`

    - #### ord

          public long ord()

      Return the offset of the next value to read.

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