--- /dev/null
+package org.apache.lucene.search;
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import java.io.IOException;
+
+import junit.framework.Assert;
+import org.apache.lucene.index.IndexReader;
+
+/**
+ * A unit test helper class to test when the filter is getting cached and when it is not.
+ */
+public class CachingWrapperFilterHelper extends CachingWrapperFilter {
+
+ private boolean shouldHaveCache = false;
+
+ /**
+ * @param filter Filter to cache results of
+ */
+ public CachingWrapperFilterHelper(Filter filter) {
+ super(filter);
+ }
+
+ public void setShouldHaveCache(boolean shouldHaveCache) {
+ this.shouldHaveCache = shouldHaveCache;
+ }
+
+ @Override
+ public synchronized DocIdSet getDocIdSet(IndexReader reader) throws IOException {
+
+ final int saveMissCount = missCount;
+ DocIdSet docIdSet = super.getDocIdSet(reader);
+
+ if (shouldHaveCache) {
+ Assert.assertEquals("Cache should have data ", saveMissCount, missCount);
+ } else {
+ Assert.assertTrue("Cache should be null " + docIdSet, missCount > saveMissCount);
+ }
+
+ return docIdSet;
+ }
+
+ @Override
+ public String toString() {
+ return "CachingWrapperFilterHelper("+filter+")";
+ }
+
+ @Override
+ public boolean equals(Object o) {
+ if (!(o instanceof CachingWrapperFilterHelper)) return false;
+ return this.filter.equals(o);
+ }
+
+ @Override
+ public int hashCode() {
+ return this.filter.hashCode() ^ 0x5525aacb;
+ }
+}