Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ByteBufferIndexInput

    Base IndexInput implementation that uses an array of J2N.IO.ByteBuffers to represent a file.

    Because Java's J2N.IO.ByteBuffer uses an System.Int32 to address the values, it's necessary to access a file greater System.Int32.MaxValue in size using multiple byte buffers.

    For efficiency, this class requires that the buffers are a power-of-two (chunkSizePower).

    Inheritance
    System.Object
    DataInput
    IndexInput
    ByteBufferIndexInput
    MMapDirectory.MMapIndexInput
    Implements
    System.IDisposable
    Inherited Members
    IndexInput.Dispose()
    DataInput.ReadBytes(Byte[], Int32, Int32, Boolean)
    DataInput.ReadVInt32()
    DataInput.ReadVInt64()
    DataInput.ReadString()
    DataInput.ReadStringStringMap()
    DataInput.ReadStringSet()
    DataInput.SkipBytes(Int64)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: Lucene.Net.Store
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class ByteBufferIndexInput : IndexInput, IDisposable

    Properties

    | Improve this Doc View Source

    Length

    Declaration
    public sealed override long Length { get; }
    Property Value
    Type Description
    System.Int64
    Overrides
    IndexInput.Length
    | Improve this Doc View Source

    Position

    Declaration
    public sealed override long Position { get; }
    Property Value
    Type Description
    System.Int64
    Overrides
    IndexInput.Position

    Methods

    | Improve this Doc View Source

    Clone()

    Declaration
    public sealed override object Clone()
    Returns
    Type Description
    System.Object
    Overrides
    IndexInput.Clone()
    | Improve this Doc View Source

    Dispose(Boolean)

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    IndexInput.Dispose(Boolean)
    | Improve this Doc View Source

    FreeBuffer(ByteBuffer)

    Called when the contents of a buffer will be no longer needed.

    Declaration
    protected abstract void FreeBuffer(ByteBuffer b)
    Parameters
    Type Name Description
    J2N.IO.ByteBuffer b
    | Improve this Doc View Source

    ReadByte()

    Declaration
    public sealed override byte ReadByte()
    Returns
    Type Description
    System.Byte
    Overrides
    DataInput.ReadByte()
    | Improve this Doc View Source

    ReadBytes(Byte[], Int32, Int32)

    Declaration
    public sealed override void ReadBytes(byte[] b, int offset, int len)
    Parameters
    Type Name Description
    System.Byte[] b
    System.Int32 offset
    System.Int32 len
    Overrides
    DataInput.ReadBytes(Byte[], Int32, Int32)
    | Improve this Doc View Source

    ReadInt16()

    NOTE: this was readShort() in Lucene

    Declaration
    public sealed override short ReadInt16()
    Returns
    Type Description
    System.Int16
    Overrides
    DataInput.ReadInt16()
    | Improve this Doc View Source

    ReadInt32()

    NOTE: this was readInt() in Lucene

    Declaration
    public sealed override int ReadInt32()
    Returns
    Type Description
    System.Int32
    Overrides
    DataInput.ReadInt32()
    | Improve this Doc View Source

    ReadInt64()

    NOTE: this was readLong() in Lucene

    Declaration
    public sealed override long ReadInt64()
    Returns
    Type Description
    System.Int64
    Overrides
    DataInput.ReadInt64()
    | Improve this Doc View Source

    Seek(Int64)

    Declaration
    public sealed override void Seek(long pos)
    Parameters
    Type Name Description
    System.Int64 pos
    Overrides
    IndexInput.Seek(Int64)
    | Improve this Doc View Source

    Slice(String, Int64, Int64)

    Creates a slice of this index input, with the given description, offset, and length. The slice is seeked to the beginning.

    Declaration
    public ByteBufferIndexInput Slice(string sliceDescription, long offset, long length)
    Parameters
    Type Name Description
    System.String sliceDescription
    System.Int64 offset
    System.Int64 length
    Returns
    Type Description
    ByteBufferIndexInput
    | Improve this Doc View Source

    ToString()

    Declaration
    public sealed override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    IndexInput.ToString()

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    Back to top Copyright © 2021 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.