Interface QueryLimit

  • All Superinterfaces:
    org.apache.lucene.index.QueryTimeout
    All Known Implementing Classes:
    CpuAllowedLimit, TimeAllowedLimit

    public interface QueryLimit
    extends org.apache.lucene.index.QueryTimeout
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Object currentValue()
      A value representing the portion of the specified limit that has been consumed.
      • Methods inherited from interface org.apache.lucene.index.QueryTimeout

        shouldExit
    • Method Detail

      • currentValue

        Object currentValue()
        A value representing the portion of the specified limit that has been consumed. Reading this value should never affect the outcome (other than the time it takes to do it).
        Returns:
        an expression of the amount of the limit used so far, numeric if possible, if non-numeric it should have toString() suitable for logging or similar expression to the user.