From c644322f131b7fcfb4e86d73471d275def399234 Mon Sep 17 00:00:00 2001 From: Erik Hatcher Date: Fri, 3 Oct 2003 03:03:39 +0000 Subject: [PATCH] Add some javadoc git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150075 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/lucene/search/CachingWrapperFilter.java | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/java/org/apache/lucene/search/CachingWrapperFilter.java b/src/java/org/apache/lucene/search/CachingWrapperFilter.java index 0d043ed269e..d6f6d5f268a 100644 --- a/src/java/org/apache/lucene/search/CachingWrapperFilter.java +++ b/src/java/org/apache/lucene/search/CachingWrapperFilter.java @@ -61,7 +61,10 @@ import java.util.Map; import java.io.IOException; /** - * @todo add documentation after this is fully accepted + * Wraps another filters result and caches it. The caching + * behavior is like {@link QueryFilter}. The purpose is to allow + * filters to simply filter, and then wrap with this class to add + * caching, keeping the two concerns decoupled yet composable. */ public class CachingWrapperFilter extends Filter { private Filter filter; @@ -74,8 +77,6 @@ public class CachingWrapperFilter extends Filter { /** * @param filter Filter to cache results of - * @todo Do we want another constructor to allow user to supply - * a backing caching Map implementation? */ public CachingWrapperFilter(Filter filter) { this.filter = filter;