@PublicApi public class

SharedEntitySearchResult

extends Object
implements EnclosedIterable<T>
java.lang.Object
   ↳ com.atlassian.jira.sharing.search.SharedEntitySearchResult<E extends com.atlassian.jira.sharing.SharedEntity>

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

A pair that contains the result status of SharedEntity search. It contains the actual results and a boolean value that indicates whether or not more results are still available. It also contains the total number of results found, which may be greater than the original page size requested.

Summary

Public Constructors
SharedEntitySearchResult(EnclosedIterable<E> results, boolean hasNext, int totalResultCount)
Public Methods
boolean equals(Object o)
final void foreach(Consumer<E> sink)
List<E> getResults()
Prefer the foreach(Consumer) method if the result size is large as it doesn't load everything into memory.
int getTotalResultCount()
boolean hasMoreResults()
int hashCode()
boolean isEmpty()
int size()
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.util.collect.EnclosedIterable
From interface com.atlassian.jira.util.collect.Sized

Public Constructors

public SharedEntitySearchResult (EnclosedIterable<E> results, boolean hasNext, int totalResultCount)

Public Methods

public boolean equals (Object o)

public final void foreach (Consumer<E> sink)

public List<E> getResults ()

Prefer the foreach(Consumer) method if the result size is large as it doesn't load everything into memory.

Returns
  • a list of results

public int getTotalResultCount ()

Returns
  • the total number of results found in a search. This will always be >= size()

public boolean hasMoreResults ()

public int hashCode ()

public boolean isEmpty ()

public int size ()