LUCENE-2468: strengthen javadocs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@949311 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Michael McCandless 2010-05-28 22:24:39 +00:00
parent 85a977bf9d
commit dc26c26956
2 changed files with 13 additions and 1 deletions

View File

@ -29,7 +29,13 @@ import org.apache.lucene.util.Bits;
/** /**
* Wraps another filter's result and caches it. The purpose is to allow * Wraps another filter's result and caches it. The purpose is to allow
* filters to simply filter, and then wrap with this class to add caching. * filters to simply filter, and then wrap with this class
* to add caching.
*
* <p><b>NOTE</b>: if you wrap this filter as a query (eg,
* using ConstantScoreQuery), you'll likely want to enforce
* deletions (using either {@link DeletesMode#RECACHE} or
* {@link DeletesMode#DYNAMIC}).
*/ */
public class CachingWrapperFilter extends Filter { public class CachingWrapperFilter extends Filter {
Filter filter; Filter filter;

View File

@ -26,6 +26,12 @@ import java.util.Set;
/** /**
* A query that wraps a filter and simply returns a constant score equal to the * A query that wraps a filter and simply returns a constant score equal to the
* query boost for every document in the filter. * query boost for every document in the filter.
*
* <p><b>NOTE</b>: if the wrapped filter is an instance of
* {@link CachingWrapperFilter}, you'll likely want to
* enforce deletions in the filter (using either {@link
* CachingWrapperFilter.DeletesMode#RECACHE} or {@link
* CachingWrapperFilter.DeletesMode#DYNAMIC}).
*/ */
public class ConstantScoreQuery extends Query { public class ConstantScoreQuery extends Query {
protected final Filter filter; protected final Filter filter;