public class

NullResultFilter

extends Object
implements LuceneResultFilter
java.lang.Object
   ↳ com.atlassian.confluence.search.v2.lucene.NullResultFilter

Class Overview

Result filter that allows everything into the final result set. Not recommended as you'll blow out huge amounts of memory loading large results!

Summary

Public Constructors
NullResultFilter()
Public Methods
boolean equals(Object obj)
int getExpectedResultsCount()
The number of results that the filter expects to allow into the final search result.
int hashCode()
boolean isIncludedInResults(WrappedHit hit)
boolean shouldContinueIterating()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.search.v2.lucene.LuceneResultFilter

Public Constructors

public NullResultFilter ()

Public Methods

public boolean equals (Object obj)

public int getExpectedResultsCount ()

The number of results that the filter expects to allow into the final search result. This is used as a purely advisory number to initialise the size of collections, and so on. Returning a number less than or equal to zero indicates that the filter has no idea how many results it is likely to return.

Returns
  • the number of results the filter expects to permit in the search results, or zero if no prediction can be made.

public int hashCode ()

public boolean isIncludedInResults (WrappedHit hit)

public boolean shouldContinueIterating ()