com.atlassian.confluence.search.v2.lucene

Class NullResultFilter

java.lang.Object

com.atlassian.confluence.search.v2.lucene.NullResultFilter

All Implemented Interfaces:

LuceneResultFilter

public class NullResultFilter
extends Object
implements LuceneResultFilter

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

Constructor Summary

Constructors

Constructor and Description
NullResultFilter()

Method Summary

Modifier and Type	Method and Description
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()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NullResultFilter

public NullResultFilter()

Method Detail

isIncludedInResults

public boolean isIncludedInResults(WrappedHit hit)

Specified by:

isIncludedInResults in interface LuceneResultFilter

shouldContinueIterating

public boolean shouldContinueIterating()

Specified by:

shouldContinueIterating in interface LuceneResultFilter

getExpectedResultsCount

public int getExpectedResultsCount()

Description copied from interface: LuceneResultFilter

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.

Specified by:

getExpectedResultsCount in interface LuceneResultFilter

Returns:

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

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object