Class OffsetsEnum

    • Field Detail

      • EMPTY

        public static final OffsetsEnum EMPTY
        Empty enumeration
    • Constructor Detail

      • OffsetsEnum

        public OffsetsEnum()
    • Method Detail

      • compareTo

        public int compareTo​(OffsetsEnum other)
        Specified by:
        compareTo in interface java.lang.Comparable<OffsetsEnum>
      • nextPosition

        public abstract boolean nextPosition()
                                      throws java.io.IOException
        Advances to the next position and returns true, or if can't then returns false. Note that the initial state of this class is not positioned.
        Throws:
        java.io.IOException
      • freq

        public abstract int freq()
                          throws java.io.IOException
        An estimate of the number of occurrences of this term/OffsetsEnum.
        Throws:
        java.io.IOException
      • getTerm

        public abstract BytesRef getTerm()
                                  throws java.io.IOException
        The term at this position. This BytesRef is safe to continue to refer to, even after we move to the next position.
        Throws:
        java.io.IOException
        See Also:
        Passage.getMatchTerms()
      • startOffset

        public abstract int startOffset()
                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • endOffset

        public abstract int endOffset()
                               throws java.io.IOException
        Throws:
        java.io.IOException
      • close

        public void close()
                   throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object