org.apache.lucene.store

## Class RAMInputStream

- java.lang.Object
- - org.apache.lucene.store.DataInput
  - - org.apache.lucene.store.IndexInput
    - - org.apache.lucene.store.RAMInputStream

- All Implemented Interfaces:
    Closeable, AutoCloseable, Cloneable

  Deprecated.
  This class uses inefficient synchronization and is discouraged in favor of `MMapDirectory`. It will be removed in future versions of Lucene.

      @Deprecated
      public class RAMInputStream
      extends IndexInput
      implements Cloneable

  A memory-resident `IndexInput` implementation.
  NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `RAMInputStream(String name, RAMFile f)` Deprecated.

  - ### Method Summary

    All Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `close()` Deprecated. Closes the stream to further operations.
    `long` | `getFilePointer()` Deprecated. Returns the current position in this file, where the next read will occur.
    `long` | `length()` Deprecated. The number of bytes in the file.
    `byte` | `readByte()` Deprecated. Reads and returns a single byte.
    `void` | `readBytes(byte[] b, int offset, int len)` Deprecated. Reads a specified number of bytes into an array at the specified offset.
    `void` | `seek(long pos)` Deprecated. Sets current position in this file, where the next read will occur.
    `IndexInput` | `slice(String sliceDescription, long offset, long sliceLength)` Deprecated. Creates a slice of this index input, with the given description, offset, and length.

    - ### Methods inherited from class org.apache.lucene.store.IndexInput

      `clone, getFullSliceDescription, randomAccessSlice, toString`

    - ### Methods inherited from class org.apache.lucene.store.DataInput

      `readBytes, readInt, readLELongs, readLong, readMapOfStrings, readSetOfStrings, readShort, readString, readVInt, readVLong, readZInt, readZLong, skipBytes`

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

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

- - ### Constructor Detail

    - #### RAMInputStream

          public RAMInputStream(String name,
                                RAMFile f)
                         throws IOException

      Deprecated.
      Throws:
        `IOException`

  - ### Method Detail

    - #### close

          public void close()

      Deprecated.
      Description copied from class: `IndexInput`
      Closes the stream to further operations.
      Specified by:
        `close` in interface `Closeable`
      Specified by:
        `close` in interface `AutoCloseable`
      Specified by:
        `close` in class `IndexInput`

    - #### length

          public long length()

      Deprecated.
      Description copied from class: `IndexInput`
      The number of bytes in the file.
      Specified by:
        `length` in class `IndexInput`

    - #### readByte

          public byte readByte()
                        throws IOException

      Deprecated.
      Description copied from class: `DataInput`
      Reads and returns a single byte.
      Specified by:
        `readByte` in class `DataInput`
      Throws:
        `IOException`
      See Also:
        `DataOutput.writeByte(byte)`

    - #### readBytes

          public void readBytes(byte[] b,
                                int offset,
                                int len)
                         throws IOException

      Deprecated.
      Description copied from class: `DataInput`
      Reads a specified number of bytes into an array at the specified offset.
      Specified by:
        `readBytes` in class `DataInput`
      Parameters:
        `b` - the array to read bytes into
        `offset` - the offset in the array to start storing bytes
        `len` - the number of bytes to read
      Throws:
        `IOException`
      See Also:
        `DataOutput.writeBytes(byte[],int)`

    - #### getFilePointer

          public long getFilePointer()

      Deprecated.
      Description copied from class: `IndexInput`
      Returns the current position in this file, where the next read will occur.
      Specified by:
        `getFilePointer` in class `IndexInput`
      See Also:
        `IndexInput.seek(long)`

    - #### seek

          public void seek(long pos)
                    throws IOException

      Deprecated.
      Description copied from class: `IndexInput`
      Sets current position in this file, where the next read will occur. If this is beyond the end of the file then this will throw `EOFException` and then the stream is in an undetermined state.
      Specified by:
        `seek` in class `IndexInput`
      Throws:
        `IOException`
      See Also:
        `IndexInput.getFilePointer()`

    - #### slice

          public IndexInput slice(String sliceDescription,
                                  long offset,
                                  long sliceLength)
                           throws IOException

      Deprecated.
      Description copied from class: `IndexInput`
      Creates a slice of this index input, with the given description, offset, and length. The slice is sought to the beginning.
      Specified by:
        `slice` in class `IndexInput`
      Throws:
        `IOException`

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