From 10fb3c64a59e592c73b2f6d3a91b85ebbd7f3e69 Mon Sep 17 00:00:00 2001 From: Daniel Naber Date: Wed, 5 Oct 2005 20:14:56 +0000 Subject: [PATCH] small javadoc improvements git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@295101 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/lucene/search/IndexSearcher.java | 3 +++ src/java/org/apache/lucene/search/Searcher.java | 5 ++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/src/java/org/apache/lucene/search/IndexSearcher.java b/src/java/org/apache/lucene/search/IndexSearcher.java index f6b9c099bd5..fbe67e9e34f 100644 --- a/src/java/org/apache/lucene/search/IndexSearcher.java +++ b/src/java/org/apache/lucene/search/IndexSearcher.java @@ -29,6 +29,9 @@ import org.apache.lucene.index.Term; *

Applications usually need only call the inherited {@link #search(Query)} * or {@link #search(Query,Filter)} methods. For performance reasons it is * recommended to open only one IndexSearcher and use it for all of your searches. + * + *

Note that you can only access Hits from an IndexSearcher as long as it is + * not yet closed, otherwise an IOException will be thrown. */ public class IndexSearcher extends Searcher { IndexReader reader; diff --git a/src/java/org/apache/lucene/search/Searcher.java b/src/java/org/apache/lucene/search/Searcher.java index 1732bb2a929..6ff090f32f3 100644 --- a/src/java/org/apache/lucene/search/Searcher.java +++ b/src/java/org/apache/lucene/search/Searcher.java @@ -21,7 +21,10 @@ import java.io.IOException; import org.apache.lucene.index.Term; /** An abstract base class for search implementations. - * Implements some common utility methods. + * Implements the main search methods. + * + *

Note that you can only access Hits from a Searcher as long as it is + * not yet closed, otherwise an IOException will be thrown. */ public abstract class Searcher implements Searchable {