org.apache.lucene.search
Class CollectionTerminatedException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by org.apache.lucene.search.CollectionTerminatedException
All Implemented Interfaces:
Serializable

public final class CollectionTerminatedException
extends RuntimeException

Throw this exception in Collector.collect(int) to prematurely terminate collection of the current leaf.

Note: IndexSearcher swallows this exception and never re-throws it. As a consequence, you should not catch it when calling IndexSearcher.search(org.apache.lucene.search.Query, int) as it is unnecessary and might hide misuse of this exception.

See Also:
Serialized Form

Constructor Summary
CollectionTerminatedException()
          Sole constructor.
 
Method Summary
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CollectionTerminatedException

public CollectionTerminatedException()
Sole constructor.



Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.