Show / Hide Table of Contents

    Interface IBytesRefIterator

    A simple iterator interface for BytesRef iteration.

    Namespace: Lucene.Net.Util
    Assembly: Lucene.Net.dll
    Syntax
    public interface IBytesRefIterator

    Properties

    | Improve this Doc View Source

    Comparer

    Return the BytesRef Comparer used to sort terms provided by the iterator. This may return null if there are no items or the iterator is not sorted. Callers may invoke this method many times, so it's best to cache a single instance & reuse it.

    Declaration
    IComparer<BytesRef> Comparer { get; }
    Property Value
    Type Description
    IComparer<BytesRef>

    Methods

    | Improve this Doc View Source

    Next()

    Increments the iteration to the next BytesRef in the iterator. Returns the resulting BytesRef or null if the end of the iterator is reached. The returned BytesRef may be re-used across calls to Next(). After this method returns null, do not call it again: the results are undefined.

    Declaration
    BytesRef Next()
    Returns
    Type Description
    BytesRef

    The next BytesRef in the iterator or null if the end of the iterator is reached.

    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)