public interface

SearchResults

implements Iterable<T>
com.atlassian.confluence.search.v2.SearchResults
Known Indirect Subclasses

Class Overview

The results of a search.

Summary

Public Methods
List<SearchResult> getAll()
Creates a new list containing all returned search results.
List<String> getSearchWords()
int getUnfilteredResultsCount()
Get the number of search results before any filter was applied.
Iterator<SearchResult> iterator()
Gets an iterator to run through the returned search results.
int size()
Get the number of search results included in this object.
[Expand]
Inherited Methods
From interface java.lang.Iterable

Public Methods

public List<SearchResult> getAll ()

Creates a new list containing all returned search results.

Returns
  • a new list containing all returned search results

public List<String> getSearchWords ()

Returns
  • a list of the words in the query string that were actually used in the search (raw query string with the stop words removed). May be an empty list if there were none.

public int getUnfilteredResultsCount ()

Get the number of search results before any filter was applied. For example, if you ran a filter to limit the number of results returned, this would give the total number of hits for your query before the limit was taken into account.

Returns
  • the number of search results available before filtering was performed

public Iterator<SearchResult> iterator ()

Gets an iterator to run through the returned search results.

Returns
  • an iterator over the search results

public int size ()

Get the number of search results included in this object.

Returns
  • the number of search results returned