Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class AbstractBlockPackedWriter

    Inheritance
    object
    AbstractBlockPackedWriter
    BlockPackedWriter
    MonotonicBlockPackedWriter
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.Util.Packed
    Assembly: Lucene.Net.dll
    Syntax
    public abstract class AbstractBlockPackedWriter

    Constructors

    AbstractBlockPackedWriter(DataOutput, int)

    Sole constructor.

    Declaration
    protected AbstractBlockPackedWriter(DataOutput @out, int blockSize)
    Parameters
    Type Name Description
    DataOutput out
    int blockSize

    the number of values of a single block, must be a multiple of 64.

    Fields

    m_blocks

    Declaration
    protected byte[] m_blocks
    Field Value
    Type Description
    byte[]

    m_finished

    Declaration
    protected bool m_finished
    Field Value
    Type Description
    bool

    m_off

    Declaration
    protected int m_off
    Field Value
    Type Description
    int

    m_ord

    Declaration
    protected long m_ord
    Field Value
    Type Description
    long

    m_out

    Declaration
    protected DataOutput m_out
    Field Value
    Type Description
    DataOutput

    m_values

    Declaration
    protected readonly long[] m_values
    Field Value
    Type Description
    long[]

    Properties

    Ord

    Return the number of values which have been added.

    Declaration
    public virtual long Ord { get; }
    Property Value
    Type Description
    long

    Methods

    Add(long)

    Append a new long.

    Declaration
    public virtual void Add(long l)
    Parameters
    Type Name Description
    long l

    Finish()

    Flush all buffered data to disk. This instance is not usable anymore after this method has been called until Reset(DataOutput) has been called.

    Declaration
    public virtual void Finish()

    Flush()

    Declaration
    protected abstract void Flush()

    Reset(DataOutput)

    Reset this writer to wrap out. The block size remains unchanged.

    NOTE: When overriding this method, be aware that the constructor of this class calls a private method and not this virtual method. So if you need to override the behavior during the initialization, call your own private method from the constructor with whatever custom behavior you need.

    Declaration
    public virtual void Reset(DataOutput @out)
    Parameters
    Type Name Description
    DataOutput out

    WriteValues(int)

    Declaration
    protected void WriteValues(int bitsRequired)
    Parameters
    Type Name Description
    int bitsRequired
    Back to top Copyright © 2024 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.