Package org.apache.lucene.search

Class TimeLimitingCollector.TimeExceededException

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing class:
    TimeLimitingCollector
    public static class TimeLimitingCollector.TimeExceededException
extends java.lang.RuntimeException
    Thrown when elapsed search time exceeds allowed search time.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private TimeExceededException​(long timeAllowed, long timeElapsed, int lastDocCollected)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getLastDocCollected()
      Returns last doc (absolute doc id) that was collected when the search time exceeded.
      long getTimeAllowed()
      Returns allowed time (milliseconds).
      long getTimeElapsed()
      Returns elapsed time (milliseconds).

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • timeAllowed

        private long timeAllowed

      • timeElapsed

        private long timeElapsed

      • lastDocCollected

        private int lastDocCollected

    • Constructor Detail

      • TimeExceededException

        private TimeExceededException​(long timeAllowed,
                              long timeElapsed,
                              int lastDocCollected)

    • Method Detail

      • getTimeAllowed

        public long getTimeAllowed()
        Returns allowed time (milliseconds).

      • getTimeElapsed

        public long getTimeElapsed()
        Returns elapsed time (milliseconds).

      • getLastDocCollected

        public int getLastDocCollected()
        Returns last doc (absolute doc id) that was collected when the search time exceeded.