@PublicApi public interface

IssuesIterable

implements EnclosedIterable<T>
com.atlassian.jira.issue.util.IssuesIterable
Known Indirect Subclasses

@PublicApi

This interface 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).

Summary

Public Methods
String toString()
Return a user friendly message that identifies which issues this iterable holds.
[Expand]
Inherited Methods
From interface com.atlassian.jira.util.collect.EnclosedIterable
From interface com.atlassian.jira.util.collect.Sized

Public Methods

public String toString ()

Return a user friendly message that identifies which issues this iterable holds. If there is a problem, this method is used to log what issues are affected.

For example, if there is a problem locking the Lucene index this method is used to log which issues could not be reindexed.

Hence, it is important to provide a useful implementation for this method.